Skip to contents

Adds a Bundle Project

Source: R/dcf_add_bundle.R
dcf_add_bundle.Rd

Establishes a new data bundle project, used to prepare outputs from standardized datasets.

Usage

dcf_add_bundle(
  name,
  project_dir = ".",
  source_files = NULL,
  open_after = interactive()
)

Arguments

name

Name of the bundle

project_dir

Path to the Data Collection Framework project.

source_files

A list or character vector, with names as paths to standard files form source projects (relative to the project's data directory), and distribution file names as entries. This associates input with output files, allowing for calculation of a source state, and metadata inheritance from source files.

open_after

Logical; if FALSE, will not open the project.

Value

Nothing; creates default files and directories.

Project

Within a bundle project, there are two files to edits:

  • build.R: This is the primary script, which is automatically rerun. It should read data from the standard directory of source projects, and write to it's own dist directory.

  • measure_info.json: This should list all non-ID variable names in the data files within dist. These will inherit the standard measure info if found in the source projects referred to in source_files. If the dist name is different, but should still inherit standard measure info, a source_id entry with the original measure ID will be used to identify the original measure info. See dcf_measure_info.

Examples

project_dir <- paste0(tempdir(), "/temp_project")
dcf_init("temp_project", dirname(project_dir))
dcf_add_bundle("bundle_name", project_dir)
list.files(paste0(project_dir, "/data/bundle_name"))
#> [1] "README.md"         "build.R"           "dist"             
#> [4] "measure_info.json" "process.json"      "project.Rproj"