load_fork: Fork a Dataset or Load a Pre-existing Fork

Description Usage Arguments

Description

If a fork of dataset ds0 named name exists, load that dataset, else create that fork.

Usage

1
2
3
load_fork(origin_dataset, fork_name, origin_project = NULL,
  fork_project = NULL, kind = c("active", "all", "archived"),
  refresh = FALSE)

Arguments

origin_dataset

A Crunch dataset or the name of a dataset. The original dataset to be forked. If a character is provided, the original dataset will only be loaded if a fork does not exist and needs to be created.

fork_name

character, the name of the dataset fork to be loaded or created.

origin_project

ProjectFolder entity, character name (path) to a project, or NULL, the default. Project folder for the original dataset if origin_dataset is supplied as a character. If a Project entity or reference is supplied, either here or as a path in dataset, the dataset lookup will be limited to that project only.

fork_project

ProjectFolder entity, character name (path) to a project, or NULL, the default. If a Project entity or reference is supplied, either here or as a path in dataset, the dataset lookup will be limited to that project only.

kind

character specifying whether to look in active, archived, or all datasets. Default is "active", i.e. non-archived.

refresh

logical; should the function check the Crunch API for new datasets? Default is FALSE.


domjarkey/crunchscripts documentation built on June 6, 2019, 7:43 p.m.