| Title: | Client for 'AcademyOcean API' |
| Version: | 0.3.3 |
| Description: | Provide function for work with 'AcademyOcean API' https://academyocean.com/api. |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.2.1 |
| Imports: | cli, dplyr, httr2, pbapply, purrr, rappdirs, retry, rlang, stringr, tidyr, utils, withr |
| NeedsCompilation: | no |
| Packaged: | 2024-07-26 08:20:34 UTC; SAMSUNG |
| Author: | Alexey Seleznev 
[aut, cre],
Netpeak [cph],
AcademyOcean [cph] |
| Maintainer: | Alexey Seleznev <selesnow@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2024-07-26 09:00:02 UTC |
racademyocean: Client for 'AcademyOcean API'
Description
Provide function for work with 'AcademyOcean API' https://academyocean.com/api.
Author(s)
Maintainer: Alexey Seleznev selesnow@gmail.com (ORCID)
Other contributors:
Netpeak [copyright holder]
AcademyOcean [copyright holder]
Authorization in 'AcademyOcean'
Description
Authorization in 'AcademyOcean'
Usage
ao_auth(
client_id = ao_get_client_id(),
client_secret = ao_get_client_secret(),
token_path = oa_get_token_path()
)
Arguments
client_id |
ID of your App |
client_secret |
Secret of your app |
token_path |
Your directory for credential storage |
Value
Auth object
See Also
See Documentation
Get the list of all academies. It returns the list of all academies in account with a description of them.
Description
Get the list of all academies. It returns the list of all academies in account with a description of them.
Usage
ao_get_academies()
Value
tibble with academies
This returns certificates received by learners
Description
This returns certificates received by learners
Usage
ao_get_certificates(emails, cl = NULL)
Arguments
emails |
Search for a user by email |
cl |
A cluster object created by |
Value
tibble with certificates
This returns a learner’s progress in all active courses/groups.
Description
This returns a learner’s progress in all active courses/groups.
Usage
ao_get_course_progress(emails, cl = NULL)
Arguments
emails |
Search for a users by emails |
cl |
A cluster object created by |
Value
tibble with course progress
This returns an array of learners from the Academy, or an empty array, if there is no data.
Description
This returns an array of learners from the Academy, or an empty array, if there is no data.
Usage
ao_get_leaners()
Value
tibble with leaners
This returns a breakdown of learners by country.
Description
This returns a breakdown of learners by country.
Usage
ao_get_leaners_amount_from_countries(country_iso_code = NULL)
Arguments
country_iso_code |
Country iso code |
Value
tibble with leaners geo
Examples
## Not run:
leaners_stat <- ao_get_leaners_amount_from_countries(
country_iso_code = "UA"
)
## End(Not run)
This returns a list of learners from the chosen country
Description
This returns a list of learners from the chosen country
Usage
ao_get_leaners_from_country(country_iso_code)
Arguments
country_iso_code |
Country iso code |
Value
tibble with leaners
Examples
## Not run:
ua_leaners <- ao_get_leaners_from_country("UA")
## End(Not run)
This returns a learner’s progress in specified courses
Description
This returns a learner’s progress in specified courses
Usage
ao_get_leaners_progress_by_course(course_id, course_slug, cl = NULL)
Arguments
course_id |
Course ID, you can get from course settings, from field “API, Course ID” |
course_slug |
Course slug, you can get from course settings, from field ‘course URL’ |
cl |
A cluster object created by |
Value
When the request is executed, an array of learner’s information is returned
This returns an array of learners from the Academy, or an empty array, if there is no data.
Description
This returns an array of learners from the Academy, or an empty array, if there is no data.
Usage
ao_get_leaners_registered_at(
date = Sys.Date() - 1,
operator = c("=", ">", "<", ">=", "<=", "<>")
)
Arguments
date |
Date string for filter |
operator |
One of the following comparison operators '=', '>', '<', '>=', '<=', '<>' |
Value
tibble with leaners
This returns a list of learners filtered by their score
Description
This returns a list of learners filtered by their score
Usage
ao_get_leaners_with_score(
score = 1,
operator = c(">=", ">", "<", "=", "<=", "<>")
)
Arguments
score |
Filter score the ratio of completed content to available content, across all courses/groups |
operator |
One of the following comparison operators '=', '>', '<', '>=', '<=', '<>' |
Value
tibble with leaners
Examples
## Not run:
leaners <- ao_get_leaners_with_score(
score = 20,
operator = '>'
)
## End(Not run)
This returns an array of learners who churned at a specific lesson in the course.
Description
This returns an array of learners who churned at a specific lesson in the course.
Usage
ao_get_learners_churn_at_content(course_id, content_id)
Arguments
course_id |
Course id, you can get it from edit course, from field ‘course URL’ |
content_id |
content id, you can get it from edit content, from field ‘lesson/quiz URL’ |
Value
tibble with leaners
Examples
## Not run:
churn <- ao_get_learners_churn_at_content(
course_id = 'ppc-spetsialist-free',
content_id = 'itogovyy-test'
)
## End(Not run)
This returns a list of learners who have completed a given course.
Description
This returns a list of learners who have completed a given course.
Usage
ao_get_learners_course_complete(course_id = "GlnLgyVkeqaXkm09Q7Y4")
Arguments
course_id |
Course id, you can get it from edit course, from field ‘course URL’ |
Value
tibble with leaners
Examples
## Not run:
leaners <- ao_get_learners_course_complete(
'ppc-spetsialist-free'
)
## End(Not run)
Returns statistics about the specified quiz for the specified learner(s).
Description
Returns statistics about the specified quiz for the specified learner(s).
Usage
ao_get_learners_quiz_statistic(email, content_id)
Arguments
email |
Search for a users by emails |
content_id |
ID of the quiz you want to see statistics for |
Value
tibble with quize stat
Examples
## Not run:
quize_stat <- ao_get_learners_quiz_statistic(
email = 'mike.p@gmail.com',
content_id = 'R9eYq5oE6wLoY3NAPmwx'
)
## End(Not run)
This returns an array of learners who logged in to the Academy more than one time.
Description
This returns an array of learners who logged in to the Academy more than one time.
Usage
ao_get_learners_repeated_logins()
Value
tibble with leaners
This returns a list of learners who registered in an Academy but took no further actions (no lessons opened)
Description
This returns a list of learners who registered in an Academy but took no further actions (no lessons opened)
Usage
ao_get_passive_leaners()
Value
tibble with leaners
This returns a list of learners who registered in an Academy but took no further actions (no lessons opened)
Description
This returns a list of learners who registered in an Academy but took no further actions (no lessons opened)
Usage
ao_get_passive_learners()
Value
tibble with passive leaners
Examples
## Not run:
passive <- ao_get_passive_learners()
## End(Not run)
Returns a list of all teams in the academy.
Description
Returns a list of all teams in the academy.
Usage
ao_get_teams()
Value
tibble with teams
Print method for academyocean_token
Description
Print method for academyocean_token
Usage
## S3 method for class 'academyocean_token'
print(x, ..., show_token = FALSE)
Arguments
x |
Auth object |
... |
Using in default print() |
show_token |
Hide or shoh access token in console |
Value
Using only for output token in console