attachment-deprecated: Deprecated functions

Description

List of functions deprecated. They will be removed in a future release.

Usage

att_to_description(
  path = ".",
  path.n = "NAMESPACE",
  path.d = "DESCRIPTION",
  dir.r = "R",
  dir.v = "vignettes",
  dir.t = "tests",
  extra.suggests = NULL,
  pkg_ignore = NULL,
  document = TRUE,
  normalize = TRUE,
  inside_rmd = NULL
)

Value

List of functions used for deprecation side effects. Output depends on the deprecated function.

Arguments

path: path to the root of the package directory. Default to current directory.
path.n: path to namespace file.
path.d: path to description file.
dir.r: Character vector of one or more directories holding R scripts to parse for dependencies. Defaults to "R". Pass several paths, for example c("R", "inst"), to also scan sources that live outside the standard package directories (a deployment entry point under inst/, say). Packages called with library() or pkg::fun() in these scripts are added to Imports, so a version already pinned for them in DESCRIPTION is preserved.
dir.v: path to vignettes directory. Set to empty (dir.v = "") to ignore.
dir.t: path to tests directory. Set to empty (dir.t = "") to ignore.
extra.suggests: vector of other packages that should be added in Suggests (pkgdown, covr for instance)
pkg_ignore: vector of packages names to ignore.
document: Run function roxygenise of roxygen2 package
normalize: Logical. Whether to normalize the DESCRIPTION file. See desc::desc_normalize()
inside_rmd: Logical or NULL. Whether the function is being called from inside a knit session, in which case the actual purl step must be delegated to an external R process. When NULL (the default), this is auto-detected via knitr::opts_knit$get("out.format").

Details

att_to_description is now called att_amend_desc so that it is the first function proposed when using auto-completion