build_iqss_package: Build an IQSS Best Practices compliant package, including...

In IQSS/IQSSdevtools: Initialize and Compile Packages Complying with IQSS Best Practices for Software Development and Sustainability

Description

Build an IQSS Best Practices compliant package, including dynamically generating documentation and running tests

Usage

build_iqss_package(path = ".", rdocs = TRUE, rdocs_args = c("rd",
  "collate", "namespace"), readme = TRUE, website = TRUE,
  website_lazy = FALSE, check = TRUE, build_source = TRUE,
  build_args = NULL, git_commit = FALSE,
  commit_message = "IQSS package build", push_to_github = FALSE, ...)

Arguments

path	character string of the package path.
rdocs	logical whether or not to roxegenize the R documentation and vignettes.
rdocs_args	character vector of roclet names to use with package. This defaults to NULL, which will use the roclets fields in the list provided in the Roxygen DESCRIPTION field. If none are specified, defaults to c("collate", "namespace", "rd").
readme	logical whether or not to render the READEM.Rmd.
website	logical whether or not to render the package website.
website_lazy	logical whether to lazy build the website (e.g. only build pages with changed Rmd files) or not.
check	logical whether or not to use check_best_practices to check that the package can be built and passes all tests. Also generates an IQSS Report Card https://github.com/IQSS/social_science_software_toolkit/blob/master/report_card/iqss_report_card_spec.md.
build_source	logical whether or not to build the package source.
build_args	character vector of arguments to pass to build. Ignored if build_source = FALSE.
git_commit	logical whether or not to commit the build to git.
commit_message	character string with a descriptive git commit message. Only relevant if git_commit = TRUE.
push_to_github	logical whether or not to push the commits to GitHub. Only relevant if git_commit = TRUE.
...	arguments to pass to methods.

See Also

document. render, build_site, check_best_practices

IQSS/IQSSdevtools documentation built on May 8, 2019, 10:54 a.m.