write_manuals_to_dv: Write manuals to dataverse

write_manuals_to_dvR Documentation

Write manuals to dataverse

Description

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

Usage

write_manuals_to_dv(
  package_1L_chr = get_dev_pkg_nm(getwd()),
  path_to_dmt_dir_1L_chr,
  pkg_dmt_dv_ds_1L_chr,
  publish_dv_1L_lgl = F,
  piggyback_desc_1L_chr = "Latest package manual PDFs.",
  piggyback_tag_1L_chr = "Documentation_0.0",
  piggyback_to_1L_chr = character(0)
)

Arguments

package_1L_chr

Package (a character vector of length one), Default: get_dev_pkg_nm(getwd())

path_to_dmt_dir_1L_chr

Path to documentation directory (a character vector of length one)

pkg_dmt_dv_ds_1L_chr

Package documentation dataverse dataset (a character vector of length one)

publish_dv_1L_lgl

Publish dataverse (a logical vector of length one), Default: F

piggyback_desc_1L_chr

Piggyback description (a character vector of length one), Default: 'Latest package manual PDFs.'

piggyback_tag_1L_chr

Piggyback tag (a character vector of length one), Default: 'Documentation_0.0'

piggyback_to_1L_chr

Piggyback to (a character vector of length one), Default: character(0)

Value

No return value, called for side effects.


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