make_carob: Make the Carob database

View source: R/process.R

make_carobR Documentation

Make the Carob database

Description

Make the Carob database.

run_carob runs a single Carob script for a dataset. Carob scripts download data to "carob/data/raw", re-organize th data, check the variable names and controlled vocabulary used, check data types, ranges, and location of the coordinates, and write clean data to "carob/data/clean"

process_carob runs all the Carob scripts.

compile_carob reads all the clean data and combines them into two files, one for the dataset descriptions, one for all records, and saves these to "carob/data")

make_carob is a convenience function that first runs process_carob and then runs compile_carob

Usage

run_carob(cleanuri, path, group="", quiet=FALSE)
process_carob(path, group="", quiet=FALSE, check=NULL, cache=TRUE)
compile_carob(path, group="", split_license=FALSE, zip=FALSE, cache=FALSE)
make_carob(path, group="", quiet=FALSE, check="all", report=FALSE, cache=TRUE, ...)

Arguments

cleanuri

character. A "clean" URI made with simple_uri

path

character. Local path to the Carob repo

group

character. group name

quiet

logical. Be quiet?

check

character. "none" to do no checking; "nogeo" to not check coordinates. "all" and all other values to do all checks

cache

logical. If TRUE, datasets are only recompiled if the R script has changed after the last compilation

report

logical. Should a html report be created for the datasets?

split_license

logical. Make a separate aggregation for data with a CC license?

zip

logical. zip the aggregated data?

...

additional arguments passed to compile_carob

Value

none. Run for the side effects.


reagro/carobiner documentation built on Dec. 4, 2024, 3:21 p.m.