Skip to contents

Create a Data Repository

Source: R/init_repository.R
init_repository.Rd

Create a repository for a dataset, which may include data documentation and/or a data site.

Usage

init_repository(dir, datasets = NULL, init_data = TRUE, init_site = TRUE,
  init_git = TRUE, template = "sdad_dashboard", overwrite = FALSE,
  quiet = !interactive())

Arguments

dir

Directory in which to create the repository's structure. Will be created if it does not exist.

datasets

A character vector of dataset names; for each of these, a subdirectory will be made containing code and data directories.

init_data

Logical; if FALSE, will not run init_data on the repository.

init_site

Logical; if FALSE, will not run init_site on the repository.

init_git

Logical; if FALSE, will not run git init on the repository.

template

A character indicating which site and build template to use, between sdad_dashboard (default) and repository_site.

overwrite

Logical; if TRUE, will overwrite existing site files in dir.

quiet

Logical; if TRUE, suppresses messages.

Value

Path to the created repository directory.

Examples

if (FALSE) {
# initialize repository in the current working directory
init_repository(".")
}