Skip to contents

Run Data Project Processes

Source: R/dcf_process.R
dcf_process.Rd

Operates over data source and bundle projects, optionally running the source ingest scripts, then collecting metadata.

Usage

dcf_process(
  name = NULL,
  project_dir = ".",
  ingest = TRUE,
  is_auto = FALSE,
  force = FALSE,
  clear_state = FALSE
)

Arguments

name

Name of a source project to process. Will

project_dir

Path to the project directory. If not specified, and being called from a source project, this will be assumed to be two steps back from the working directory.

ingest

Logical; if FALSE, will re-process standardized data without running ingestion scripts. Only applies to source projects.

is_auto

Logical; if TRUE, will skip process scripts marked as manual.

force

Logical; if TRUE, will ignore process frequencies (will run scripts even if recently run).

clear_state

Logical; if TRUE, will clear stored states before processing.

Value

A list with processing results:

  • timings: How many seconds the scripts took to run.

  • logs: The captured output of the scripts.

Each entry has an entry for each project.

A `datapackage.json` file is also created / update in each source's `standard` directory.

Examples

if (FALSE) { # \dontrun{
  # run from a directory containing a `data` directory containing the source
  dcf_process("source_name")

  # run without executing the ingestion script
  dcf_process("source_name", ingest = FALSE)
} # }