get_nutrientsource: get_nutrientsource
In jufil19/nutrientr: R Wrapper for the Canadian Nutrient File API
Description
Usage
Arguments
Value
Examples
Description
Makes a query to the Canadian Nutrient File nutrientsource endpoint. This endpoint returns
a list of nutrient source id's and their corresponding description.
Usage
1
get_nutrientsource(apiKey = NULL, nutrientSourceId = NULL, lang = "en")
Arguments
apiKey
Key to access the API. Can be retrieved from
https://hc-sc.api.canada.ca/en/detail?api=cnf#!/Nutrient/get_nutrientamount.
If none is provided, the system environment variables will be checked.
nutrientSourceId
The code indicating the nutrient source you want to search for. If null,
all nutrient sources are returned.
lang
The language to return results in, can be either 'en' or 'fr'.
Value
A tibble containing the id's of nutrient sources as well as their corresponding description.
Examples
1
2
3
4
5
## Not run:
get_nutrientsource()
get_nutrientsource(nutrientSourceId = 108)
get_nutrientsource(nutrientSourceId = 108, lang = "fr")
## End(Not run)
jufil19/nutrientr documentation built on Feb. 22, 2022, 9:40 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value Examples
Description
Makes a query to the Canadian Nutrient File nutrientsource endpoint. This endpoint returns a list of nutrient source id's and their corresponding description.
Usage
1 | get_nutrientsource(apiKey = NULL, nutrientSourceId = NULL, lang = "en")
|
Arguments
apiKey |
Key to access the API. Can be retrieved from https://hc-sc.api.canada.ca/en/detail?api=cnf#!/Nutrient/get_nutrientamount. If none is provided, the system environment variables will be checked. |
nutrientSourceId |
The code indicating the nutrient source you want to search for. If null, all nutrient sources are returned. |
lang |
The language to return results in, can be either 'en' or 'fr'. |
Value
A tibble containing the id's of nutrient sources as well as their corresponding description.
Examples
1 2 3 4 5 | ## Not run:
get_nutrientsource()
get_nutrientsource(nutrientSourceId = 108)
get_nutrientsource(nutrientSourceId = 108, lang = "fr")
## End(Not run)
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.