getcoach: Get a list of coaches, intelligently filtered by several...

In brandywwy/Rmuse: R Interface to THE MUSE API

Description

This function can make request THE MUSE API with "coaches" endponit to get a list of coaches. The results it will return include the amount of coaches that meet the criteria, coache name, bio, certifications, specializations, rating, number of reviews, etc.

Usage

getcoach(page = NULL, decending = NULL, offering = NULL,
  level = NULL, specialization = NULL, apikey = NULL)

Arguments

page	The page number to load (required).
decending	Whether to show descending results(default value: FALSE).
offering	Only show coaches for a specific offering, please refer to the vignette to find proper available offering options.
level	Only show coaches for a specific level, please refer to the vignette for available level categories.
specialization	Only show coaches for a specific specialization, please refer to the vignette to find proper available specializaiton options.
apikey	Pass your own API key can increase the rate limit from 500 to 3600 per hour.

Value

A named list with the following elements:

message

a list of messages including the number of results in specified pages, total number of results returned by the API

response

a list of API-specific response values in JSON format, including coache name, bio, certifications, specializations, rating, number of reviews, etc. At this time, no further coercion is performed, so you may have to use functions from the XML package to extract the desired output. Or you can refer to the "cleancoach" function in this package to get a clean dataframe with some key information of list of coaches.

Examples

## Not run: 
getcoach(page = 1, offering = "30-Minute Career Q&A")
getcoach(page = 2, level = "Master Coach", specialization = "College/New Grads")
## End(Not run)

brandywwy/Rmuse documentation built on Aug. 12, 2019, 1:49 p.m.