Use a pkgdevt.R script — use_pkgdevt_script • pkgdev

This function adds a script to inst/scripts/pkgdevt.R to keep track of the various steps applied setting up your R package.

Usage

use_pkgdevt_script(
  package_name = basename(getwd()),
  package_author = Sys.getenv("FULLNAME", ""),
  package_description = "My awesome description.",
  package_title = "My awesome title",
  github_private_repo = FALSE,
  open = TRUE,
  ...
)

Arguments

package_name: Name of your package
package_author: Author
package_description: Description
package_title: Title
github_private_repo: Logical
open: Should the file be opened?
...: if necessary

Value

Invisible

Details

For details see this package's pkgdevt.R script by running:

file.edit(fs::path_package("pkgdev", "scripts/pkgdevt.R")).

See also

https://github.com/jimbrig/pkgdev/blob/main/inst/scripts/pkgdevt.R

Examples

if (FALSE) {
use_pkgdevt_script("testPackage",
                   package_description = "My awesome description.",
                   package_title = "package title",
                   github_private_repo = FALSE)
}