compile: Compile ISRaD data product

In ISRaD: Tools and Data for the International Soil Radiocarbon Database

Compile ISRaD data product

Description

Compiles template files into ISRaD database format.

Usage

compile(
  dataset_directory,
  write_report = FALSE,
  write_out = FALSE,
  return_type = c("none", "list")[2],
  checkdoi = FALSE,
  verbose = TRUE
)

Arguments

dataset_directory	Directory where completed QAQCed template files are stored.
write_report	Boolean flag to write a log file of the compilation. File will be in the specified dataset_directory at "database/ISRaD_log.txt". If a file with this name already exists in this directory it will be overwritten.
write_out	Set to TRUE to write the compiled database file in .xlsx format in dataset_directory
return_type	A string that defines return object. Acceptable values are "none" or "list"; default is "list".
checkdoi	Set to FALSE if you do not want to validate DOIs during QAQC. (Warning: time consuming).
verbose	Set to TRUE to print results of function to console.

Examples

# Load example dataset Gaudinski_2001
entry <- ISRaD::Gaudinski_2001
# Save as .xlsx file
ISRaD.save.entry(
  entry = entry,
  template_file = system.file("extdata", "ISRaD_Master_Template.xlsx", package = "ISRaD"),
  outfile = file.path(tempdir(), "Gaudinski_2001.xlsx")
)
# Compile .xlsx file/s in dataset_directory into ISRaD database object
ISRaD.compiled <- compile(tempdir(),
  write_report = TRUE, write_out = TRUE,
  return_type = "list", checkdoi = FALSE, verbose = TRUE
)

ISRaD documentation built on Sept. 21, 2023, 9:06 a.m.