tidy_depot_api executes an api request for the path endpoint (e.g. Patient-Case) and returns a tidy_depot_api class object with the API call results unless there is an error

tidy_depot_api(path, token, cohortId = "")

Arguments

path

The name of an endpoint of interest (e.g. Biochemistry)

token

The token string returned from get_token() function

cohortId

The int string containing the cohortId of interest from DEPOT

Value

An object of class tidy_depot_api containing API call results

Details

This function depends upon setting up your user credentials to access the Tidy Depot API locally including your email address and secret key using store_secret_credentials in Rstudio. This will prompt you to store that information in a local .Renviron file. Afterwards, retrieve a unique token string using the get_token function which is passed as the token argument to the tidy_depot_api function along with the path end point of interest. Any errors will be returned instead of the API call notifying that there may be an issue with either your credentials or the endpoint name.

Author

Gabriel Rosenfeld, gabriel.rosenfeld@nih.gov