Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nelson-gon/rfdc
An R interface to FoodData Central
https://github.com/nelson-gon/rfdc
agriculture fdc food html json nutrition nutrition-information nutritionfacts r r-package r-stats rest rest-api rstats s4 usda user-interface xml
Last synced: 22 days ago
JSON representation
An R interface to FoodData Central
- Host: GitHub
- URL: https://github.com/nelson-gon/rfdc
- Owner: Nelson-Gon
- License: gpl-3.0
- Created: 2019-11-15T05:48:57.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-11-10T09:49:58.000Z (about 3 years ago)
- Last Synced: 2024-10-08T05:21:14.483Z (about 1 month ago)
- Topics: agriculture, fdc, food, html, json, nutrition, nutrition-information, nutritionfacts, r, r-package, r-stats, rest, rest-api, rstats, s4, usda, user-interface, xml
- Language: R
- Homepage: https://nelson-gon.github.io/rfdc/
- Size: 126 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Nelson Gonzabato
2021-11-10
# rfdc: An R Interface to FoodData Central
[](https://github.com/Nelson-Gon/rfdc/actions/workflows/check-pkg.yaml)
[](https://www.gnu.org/licenses/old-licenses/gpl-3.0.html)
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://GitHub.com/Nelson-Gon/rfdc/graphs/commit-activity)
[](http://www.repostatus.org/#active)
[](https://github.com/Nelson-Gon/rfdc/commits/master)
[](https://GitHub.com/Nelson-Gon/rfdc/issues/)
[](https://GitHub.com/Nelson-Gon/rfdc/issues?q=is%3Aissue+is%3Aclosed)
[](http://makeapullrequest.com)
# Background
This repository is intended to serve as a replacement to the R package
[usdar](https://github.com/Nelson-Gon/usdar). This was necessary because
the former API is slated for End of Life as explained in issue
[#2](https://github.com/Nelson-Gon/usdar/issues/2).
It is also based on [pyfdc](https://github.com/Nelson-Gon/pyfdc)
**Installation**
To install the package, one requires to have `devtools` installed. The
package is not on CRAN and the author does not intend to push it to CRAN
unless specific need arises.
``` r
install.packages("devtools")
devtools::install_github("Nelson-Gon/rfdc")
```
**Loading the package**
``` r
library(rfdc)
#> Please run set_api_key first.Run key_signup to get an API key.
```
**Initial Setup**
As a first step, we need to set an API key for the session via
`set_api_key` as shown below.
``` r
set_api_key()
#> AN API key already exists, enjoy!
```
To signup for an API key:
``` r
key_signup()
```
**Initialise an object**
To intialise an object, we can use `make_object`. See details about each
class below. For instance, to initialise an object of class `FoodSearch`
with the search term `indomie`:
``` r
my_object <- make_object("FoodSearch",search_phrase="indomie")
```
**Classes**
1. `FoodSearch` class
This class allows access to the food search
[endpoint](https://fdc.nal.usda.gov/api-guide.html) i.e to search/query
the database.
**Available methods**
1. `get_food_info`
To get details about our object above:
``` r
get_food_info(my_object,"description")
#> [1] "CHICKEN INSTANT NOODLES, CHICKEN"
#> [2] "CHICKEN CURRY FLAVOUR INSTANT NOODLES, CHICKEN CURRY"
#> [3] "SPECIAL CHICKEN FLAVOUR INSTANT NOODLES, CHICKEN"
```
To get multiple details:
``` r
get_food_info(my_object,c("description",'fdcId','score'))
#> description fdcId score
#> 1 CHICKEN INSTANT NOODLES, CHICKEN 1816702 -537.7092
#> 2 CHICKEN CURRY FLAVOUR INSTANT NOODLES, CHICKEN CURRY 1987917 -537.7092
#> 3 SPECIAL CHICKEN FLAVOUR INSTANT NOODLES, CHICKEN 1987671 -537.7092
```
Another example:
``` r
head(get_food_info(my_object,c('fdcId','description','score')))
#> fdcId description score
#> 1 1816702 CHICKEN INSTANT NOODLES, CHICKEN -537.7092
#> 2 1987917 CHICKEN CURRY FLAVOUR INSTANT NOODLES, CHICKEN CURRY -537.7092
#> 3 1987671 SPECIAL CHICKEN FLAVOUR INSTANT NOODLES, CHICKEN -537.7092
```
2. `get_food_details`
For the `FoodDetails` class, this returns details about a food data
central id. You can get an fdcId using `get_food_info` from `FoodSearch`
``` r
test_object <-make_object("FoodDetails",fdc_id = 504905)
get_food_details(test_object, "ingredients")
#> [1] "Using URL: https://api.nal.usda.gov/fdc/v1/food/504905?api_key=*****&nutrients="
#> $ingredients
#> [1] "MECHANICALLY SEPARATED CHICKEN, CHICKEN BROTH, WATER, CONTAINS LESS THAN 2% OF: SALT, SUGAR, SPICES, SODIUM PHOSPHATE, SODIUM ASCORBATE, SODIUM NITRITE, NATURAL FLAVORS, EXTRACTIVES OF PAPRIKA."
```
3. `get_nutrients`
To get nutrients corresponding to a food id:
``` r
head(get_nutrients(test_object))
#> [1] "Using URL: https://api.nal.usda.gov/fdc/v1/food/504905?api_key=*****&nutrients="
#> id number name rank unitName serving
#> 1 1079 291 Fiber, total dietary 1200 g 0.00
#> 2 1089 303 Iron, Fe 5400 mg 0.83
#> 3 1110 324 Vitamin D (D2 + D3), International Units 8650 IU 0.00
#> 4 1087 301 Calcium, Ca 5300 mg 62.00
#> 5 1092 306 Potassium, K 5700 mg 54.00
#> 6 1235 539 Sugars, added 1540 g 0.80
#> serving_descr
#> 1 Calculated from a daily value percentage per serving size measure
#> 2 Calculated from a daily value percentage per serving size measure
#> 3 Calculated from a daily value percentage per serving size measure
#> 4 Calculated from a daily value percentage per serving size measure
#> 5 Calculated from a daily value percentage per serving size measure
#> 6 Calculated from value per serving size measure
```
A `get_label_nutrients` method for a given Food Data Central can also be
used as follows. Unfortunately, it is unclear what the provided values
mean nutrition wise.
``` r
get_label_nutrients(test_object)
#> [1] "Using URL: https://api.nal.usda.gov/fdc/v1/food/504905?api_key=*****&nutrients="
#> fat saturatedFat transFat cholesterol sodium carbohydrates fiber sugars
#> 1 15 4.5 0 84.5 1060 2 0 1
#> protein calcium iron potassium addedSugar calories
#> 1 10 80.6 1.08 70.2 1.04 179
```
Further exploration is left to the user.
Please note that the ‘rfdc’ project is released with a [Contributor Code
of Conduct](.github/CODE_OF_CONDUCT.md). By contributing to this
project, you agree to abide by its terms.