Package: rdataretriever 3.1.1

Henry Senyondo

rdataretriever: R Interface to the Data Retriever

Provides an R interface to the Data Retriever <https://retriever.readthedocs.io/en/latest/> via the Data Retriever's command line interface. The Data Retriever automates the tasks of finding, downloading, and cleaning public datasets, and then stores them in a local database.

Authors:Henry Senyondo [aut, cre], Daniel McGlinn [aut], Pranita Sharma [aut], David J Harris [aut], Hao Ye [aut], Shawn Taylor [aut], Jeroen Ooms [aut], Francisco Rodríguez-Sánchez Ooms [aut], Karthik Ram [aut], Apoorva Pandey [aut], Harshit Bansal [aut], Max Pohlman [aut], Ethan White [aut]

rdataretriever_3.1.1.tar.gz
rdataretriever_3.1.1.zip(r-4.5)rdataretriever_3.1.1.zip(r-4.4)rdataretriever_3.1.1.zip(r-4.3)
rdataretriever_3.1.1.tgz(r-4.4-any)rdataretriever_3.1.1.tgz(r-4.3-any)
rdataretriever_3.1.1.tar.gz(r-4.5-noble)rdataretriever_3.1.1.tar.gz(r-4.4-noble)
rdataretriever_3.1.1.tgz(r-4.4-emscripten)rdataretriever_3.1.1.tgz(r-4.3-emscripten)
rdataretriever.pdf |rdataretriever.html✨
rdataretriever/json (API)

# Install 'rdataretriever' in R:
install.packages('rdataretriever', repos = c('https://ropensci.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/ropensci/rdataretriever/issues

On CRAN:

datadata-sciencedatabasedatasetsscience

7.68 score 44 stars 36 scripts 192 downloads 1 mentions 32 exports 14 dependencies

Last updated 4 months agofrom:36d927291f (on main). Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKOct 23 2024
R-4.5-winOKOct 23 2024
R-4.5-linuxOKOct 23 2024
R-4.4-winOKOct 23 2024
R-4.4-macOKOct 23 2024
R-4.3-winOKOct 23 2024
R-4.3-macOKOct 23 2024

Exports:check_for_updatescheck_retriever_availabilitycommitcommit_logdata_retriever_versiondataset_namesdatasetsdisplay_all_rdataset_namesdownloadfetchfind_socrata_dataset_by_idget_dataset_names_upstreamget_rdataset_namesget_retriever_citationget_script_citationget_script_upstreamget_updatesinstallinstall_csvinstall_jsoninstall_msaccessinstall_mysqlinstall_postgresinstall_retrieverinstall_sqliteinstall_xmlreload_scriptsresetsocrata_autocomplete_searchsocrata_dataset_infoupdate_rdataset_cataloguse_RetrieverPath

Dependencies:assertthatherejsonlitelatticeMatrixpngrappdirsRcppRcppTOMLreticulaterlangrprojrootsemverwithr

Provenance & Reproducibility Using the rdataretriever

Rendered fromprovenance.Rmdusingknitr::rmarkdownon Oct 23 2024.

Last update: 2022-01-27
Started: 2020-11-17

Using the rdataretriever to quickly analyze Breeding Bird Survey data

Rendered frombreed-bird-survey-analysis.Rmdusingknitr::rmarkdownon Oct 23 2024.

Last update: 2022-01-27
Started: 2020-10-26

Readme and manuals

Help Manual

Help pageTopics
Check for updatescheck_for_updates
Check to see if minimum version of retriever Python package is installedcheck_retriever_availability
Commit a datasetcommit
See the log of committed dataset stored in provenance directorycommit_log
Get Data Retriever versiondata_retriever_version
Name all available dataset scripts.dataset_names
Name all available dataset scripts.datasets
Displays the list of rdataset names present in the list of packages provideddisplay_all_rdataset_names
Download datasets via the Data Retriever.download
Fetch a dataset via the Data Retrieverfetch
Returns metadata for the following dataset idfind_socrata_dataset_by_id
Get dataset names from upstreamget_dataset_names_upstream
Returns a list of all the available RDataset names presentget_rdataset_names
Get retriever citationget_retriever_citation
Get citation of a scriptget_script_citation
Get scripts upstreamget_script_upstream
Update the retriever's dataset scripts to the most recent versions.get_updates
Install datasets via the Data Retriever (deprecated).install
Install datasets via the Data Retriever.install_csv
Install datasets via the Data Retriever.install_json
Install datasets via the Data Retriever.install_msaccess
Install datasets via the Data Retriever.install_mysql
Install datasets via the Data Retriever.install_postgres
install the python module `retriever`install_retriever
Install datasets via the Data Retriever.install_sqlite
Install datasets via the Data Retriever.install_xml
Update the retriever's global_script_list with the scripts present in the ~/.retriever directory.reload_scripts
Reset the scripts or data(raw_data) directory or bothreset
Returns the list of dataset names after autocompletionsocrata_autocomplete_search
Get socrata dataset infosocrata_dataset_info
Updates the datasets_url.json from the github repoupdate_rdataset_catalog
Setting path of retrieveruse_RetrieverPath