orderly_init: Initialise an orderly store

Description Usage Arguments Details Value See Also Examples

View source: R/init.R

Description

Initialise an orderly store. This is a helper function that automates getting started with using orderly for a new project. It is not required to use - you can create the orderly structure yourself (all that is compulsory is the orderly_config.yml file).

Usage

1
orderly_init(root, doc = TRUE, quiet = FALSE)

Arguments

root

The root of the store; this must be an empty directory or the path of a directory to create

doc

Logical, indicating if documentation should be added to the directories. This also has the (potentially useful) effect of making these directories noticeable by git.

quiet

Logical, indicating if informational messages should be suppressed.

Details

This function creates a minimal orderly structure, containing:

Value

The path to the newly created archive

See Also

orderly_new() for creating new reports within a configured orderly repository.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Initialise a new orderly repository in an temporary directory:
path <- orderly::orderly_init(tempfile())

# This has created the directory skeleton that you need to get
# started using orderly:
fs::dir_tree(path)

# As instructed, the next thing to do is to edit the
# orderly_config.yml file to match your needs:
readLines(file.path(path, "orderly_config.yml"))

orderly documentation built on Sept. 22, 2021, 5:09 p.m.