build_archive {galaxias}R Documentation

Build a Darwin Core Archive from a folder

Description

A Darwin Core archive is a zip file containing a combination of data and metadata. build_archive() constructs this zip file in the parent directory. The function assumes that all necessary files have been pre-constructed, and can be found inside the "data-publish" directory with no additional or redundant information. Structurally, build_archive() is similar to devtools::build(), in the sense that it takes a repository and wraps it for publication.

Usage

build_archive(file = "dwc-archive.zip", overwrite = FALSE, quiet = FALSE)

Arguments

file

The name of the file to be built in the parent directory. Should end in .zip.

overwrite

(logical) Should existing files be overwritten? Defaults to FALSE.

quiet

(logical) Whether to suppress messages about what is happening. Default is set to FALSE; i.e. messages are shown.

Details

This function looks for three types of objects in the data-publish directory:

Value

Doesn't return anything; called for the side-effect of building a 'Darwin Core Archive' (i.e. a zip file).

See Also

use_data(), use_metadata(), use_schema()


[Package galaxias version 0.1.0 Index]