write_to_tidy_pkg: Write to tidy package

write_to_tidy_pkgR Documentation

Write to tidy package

Description

write_to_tidy_pkg() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write to tidy package. The function is called for its side effects and does not return a value.

Usage

write_to_tidy_pkg(
  pkg_setup_ls,
  build_vignettes_1L_lgl = TRUE,
  clean_license_1L_lgl = TRUE,
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  examples_chr = character(0),
  options_chr = c("Y", "N"),
  project_1L_chr = "Model",
  suggest_chr = "pkgload"
)

Arguments

pkg_setup_ls

Package setup (a list)

build_vignettes_1L_lgl

Build vignettes (a logical vector of length one), Default: TRUE

clean_license_1L_lgl

Clean license (a logical vector of length one), Default: TRUE

consent_1L_chr

Consent (a character vector of length one), Default: ”

consent_indcs_int

Consent indices (an integer vector), Default: 1

examples_chr

Examples (a character vector), Default: character(0)

options_chr

Options (a character vector), Default: c("Y", "N")

project_1L_chr

Project (a character vector of length one), Default: 'Model'

suggest_chr

Suggest (a character vector), Default: 'pkgload'

Value

No return value, called for side effects.


ready4-dev/ready4fun documentation built on April 22, 2024, 8:33 a.m.