Command Documentation
Index
Main.Retriever.check_for_updatesMain.Retriever.commitMain.Retriever.commit_logMain.Retriever.create_rdatasetMain.Retriever.data_retriever_versionMain.Retriever.dataset_namesMain.Retriever.display_all_rdataset_namesMain.Retriever.downloadMain.Retriever.get_dataset_names_upstreamMain.Retriever.get_rdataset_namesMain.Retriever.get_script_citationMain.Retriever.get_script_upstreamMain.Retriever.install_csvMain.Retriever.install_jsonMain.Retriever.install_msaccessMain.Retriever.install_mysqlMain.Retriever.install_postgresMain.Retriever.install_sqliteMain.Retriever.install_xmlMain.Retriever.reload_scriptsMain.Retriever.reset_retrieverMain.Retriever.update_rdataset_catalogMain.Retriever.update_rdataset_contentsMain.Retriever.update_rdataset_script
Main.Retriever.check_for_updates — Method check_for_updates()Check Retriever scripts for updates.
Main.Retriever.commit — Function commit(dataset, commit_message::String="", path::String="", quiet::Bool=false)Commit Retriever dataset.
Main.Retriever.commit_log — Method commit_log(dataset)Get the commit log for a dataset.
Main.Retriever.create_rdataset — Functioncreate_rdataset(engine, package::String, dataset_name::String, script_path::Union{String, Nothing}=nothing)Download files for RDatasets to the raw data directory
Main.Retriever.data_retriever_version — Method data_retriever_version()Get Data Retriever version.
Main.Retriever.dataset_names — Method dataset_names()Return list of all available dataset names.
Main.Retriever.display_all_rdataset_names — Function display_all_rdataset_names(package_name::Array{String,1}=String[])Displays the list of rdataset names present in the package(s) provided
Main.Retriever.download — Method download(dataset; path::String="./", quiet::Bool=false,
subdir::String="", debug::Bool=false, use_cache::Bool=false)Download scripts for retriever.
Main.Retriever.get_dataset_names_upstream — Function get_dataset_names_upstream(keywords::Array{String,1}=String[], licenses::Array{String,1}=String[], repo::String="")Get dataset names upstream scripts.
Main.Retriever.get_rdataset_names — Method get_rdataset_names()Returns a list of all the available RDataset names present
Main.Retriever.get_script_citation — Function get_script_citation(repo::String="")Get citation for the data retriever or scripts.
Main.Retriever.get_script_upstream — Function get_script_upstream(dataset, repo::String="")Get upstream retriever-recipe's scripts.
Main.Retriever.install_csv — Method
install_csv(dataset; table_name::String="", compile::Bool=false,
data_dir=pwd(), debug::Bool=false, use_cache::Bool=true)Install Retriever scripts in csv format.
Main.Retriever.install_json — Method install_json(dataset; table_name::String="", data_dir=pwd(),
debug::Bool=false, use_cache::Bool=true)Install Retriever scripts in json format.
Main.Retriever.install_msaccess — Method install_msaccess(dataset; file::String="", table_name::String="",
data_dir=pwd(), debug::Bool=false, use_cache::Bool=true)Install Retriever scripts in msacces.
Main.Retriever.install_mysql — Method install_mysql(dataset; user::String="root",
password::String="", host::String="localhost",
port::Int=3306, database_name::String="", table_name::String="",
compile::Bool=false, debug::Bool=false, quiet::Bool=false,
use_cache::Bool=true)Install Retriever scripts in mysql database.
Main.Retriever.install_postgres — Method install_postgres(dataset; user::String="postgres",
password::String="", host::String="localhost",
port::Int=5432, database::String="postgres",
database_name::String="", table_name::String="", bbox::Any=[],
debug::Bool=false, use_cache::Bool=true)Install Retriever scripts in database.
Main.Retriever.install_sqlite — Method install_sqlite(dataset; file::String="", table_name::String="",
data_dir=pwd(), debug::Bool=false,
use_cache::Bool=true)Install Retriever scripts in database.
Main.Retriever.install_xml — Method install_xml(dataset; table_name::String="", compile::Bool=false, data_dir=pwd(),
debug::Bool=false, use_cache::Bool=true)Install Retriever scripts in xml format.
Main.Retriever.reload_scripts — Method reload_scripts()Retriever reload scripts.
Main.Retriever.reset_retriever — Function reset_retriever(scope::String="all", ask_permission::Bool=true)Retriever reset scripts or data or all.
Main.Retriever.update_rdataset_catalog — Function update_rdataset_catalog(test::Bool=false)Updates the datasets_url.json from the github repo
Main.Retriever.update_rdataset_contents — Method update_rdataset_contents(data_obj::Dict{String, String}, package::String, dataset_name::String, json_file::Dict{String, String})Update the contents of json script
Main.Retriever.update_rdataset_script — Method update_rdataset_script(data_obj, dataset_name, package, script_path)Renames and updates the RDataset script