Generate Merge Files

Submits a filled merge template to the CatMapper merge-syntax endpoint. The template may be supplied as a data frame, a list of row objects, or the path to a .xlsx, .xls, or .csv file.

Usage

generateMergeFiles(
  template,
  database = "SocioMap",
  download_zip = TRUE,
  zip_path = NULL,
  overwrite = FALSE,
  url = NULL
)

Arguments

template

A data frame, list of row objects, or file path.

database

A string specifying the target database.

download_zip

Whether to immediately download the returned zip archive.

zip_path

Optional local path for the downloaded zip archive.

overwrite

Whether to overwrite an existing zip archive when download_zip = TRUE.

url

API URL override.

Value

A list with the API response, normalized template rows, and optional zip_path.

Examples

if (FALSE) { # \dontrun{
template <- data.frame(
  mergingID = "AD354277",
  stackID = "AD354278",
  datasetID = "AD354279",
  filePath = "/path/to/local_dataset.csv",
  stringsAsFactors = FALSE
)

result <- generateMergeFiles(
  template = template,
  database = "ArchaMap",
  download_zip = TRUE,
  overwrite = TRUE
)
result$zip_path
} # }