write_template: Construct a template capeml workflow

View source: R/write_template.R

write_templateR Documentation

Construct a template capeml workflow

Description

Write a workflow template Rmd file for the capeml workflow

Usage

write_template(
      scope,
      identifier,
      path,
      overwrite
    )

Arguments

scope

(character) Quoted name of the package scope (e.g., "edi"). The default is "knb-lter-cap".

identifier

(integer) Data package identifier (number).

path

(character) Path to where the config file will be written. Defaults to the current directory.

overwrite

(logical) indicates to overwrite an existing file if one exists (default = FALSE).

Details

Existing files with the package name and .Rmd extension at path will not be overwritten unless overwrite is made explicit.

Value

A Rmarkdown (Rmd) file named with the project scope and identifier (number).

Examples

## Not run: 
# Template data package directory "edi.521"

write_template(
  scope      = "edi",
  identifier = 521,
  path       = '~/Desktop'
)


## End(Not run)


CAPLTER/capeml documentation built on April 3, 2024, 11:17 p.m.