| Title: | Retrieve Data using the 'IsoMemo' API |
| Version: | 23.10.1 |
| Date: | 2023-10-23 |
| Description: | API wrapper that contains functions to retrieve data from the 'IsoMemo' partnership databases. Web services for API: https://isomemodb.com/api/v1/iso-data. |
| Maintainer: | Jan Abel <jan.abel@inwt-statistics.de> |
| BugReports: | https://github.com/Pandora-IsoMemo/isomemo-data/issues |
| License: | GPL (≥ 3) |
| Encoding: | UTF-8 |
| Depends: | R (≥ 3.5.0) |
| Imports: | curl, jsonlite, modules |
| Suggests: | knitr, rmarkdown, testthat (≥ 3.0.0) |
| RoxygenNote: | 7.2.3 |
| VignetteBuilder: | knitr |
| Config/testthat/edition: | 3 |
| NeedsCompilation: | no |
| Packaged: | 2023-11-03 12:28:03 UTC; ljabel |
| Author: | Jan Abel [cre], Jianyin Roachell [aut], Andreas Neudecker [aut], Antonia Runge [aut], Ricardo Fernandes [aut] |
| Repository: | CRAN |
| Date/Publication: | 2023-11-03 13:00:09 UTC |
Call API
Description
Call API
Usage
callAPI(action, ...)
Arguments
action |
(character) name of the endpoint, one of "mapping-ids", "dbsources", "iso-data" or "mapping" |
... |
parameters for the endpoint, e.g. mappingId = "IsoMemo", dbsource = "LiVES, field = "site,longitude", ... |
API wrapper that fetches data from IsoMemo Applications
Description
Data retrieval for databases within the IsoMemo initiative (https://isomemo.com/). Given the parameters Database name, category names, and field names.
Usage
getData(
db = getDatabaseList(mapping = "IsoMemo"),
category = NULL,
field = NULL,
mapping = "IsoMemo"
)
Arguments
db |
(character) database options: "14CSea" "CIMA" "IntChron" "LiVES" |
category |
(character) domain specific categories of fields to retrieve: "Dating info","Isotopic proxies." If set to NULL (default) all categories are returned |
field |
(character) fields to return. If set to NULL (default) all fields will be returned |
mapping |
(character) Optionally, provide a specific mapping in order to obtain a list of databases only for that mapping. Check available mapping ids with getMappings() |
Value
A data frame containing the requested databases, category domains, and variables of interest from the user
Get Database List
Description
Get Database List
Usage
getDatabaseList(mapping = "IsoMemo")
Arguments
mapping |
(character) Optionally, provide a specific mapping in order to obtain a list of databases only for that mapping. Check available mapping ids with getMappings() |
Value
A character vector with all available databases
Get field mapping table
Description
Get field mapping table
Usage
getFields(mapping = "IsoMemo", colnamesAPI = FALSE)
Arguments
mapping |
(character) Optionally, provide a specific mapping in order to obtain a list of databases only for that mapping. Check available mapping ids with getMappings() |
colnamesAPI |
(logical) Optionally, return a dataframe with the column names as they come from the 'IsoMemo' API |
Value
A data frame that describes data field name, data type, and domain category
Get Mappings
Description
Get all available mapping ids
Usage
getMappings()
Value
A character vector with all available mapping ids