init_iqss_package: Initialize a new R package skeleton using IQSS best practices

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

Description

Initialize a new R package skeleton using IQSS best practices

Usage

init_iqss_package(path, description = getOption("devtools.desc"),
  use_rstudio = TRUE, use_pkgdown = TRUE, use_gpl3 = TRUE,
  use_tests = TRUE, use_git = TRUE, github_auth_token = github_pat(),
  github_protocol = "https", change_wd = TRUE, ...)

Arguments

path	character string of the location to create new package. The last component of the path will be used as the package name.
description	list of values for the DESCRIPTION to override the default values or add additional values.
use_rstudio	logical whether to create an Rstudio project file https://support.rstudio.com/hc/en-us/articles/200526207-Using-Projects (with use_rstudio)?
use_pkgdown	logical whether or not to initialize a pkgdown website for documenting the package.
use_gpl3	logical whether or not to include a GPL 3 license.
use_tests	logical whether or not to initialize a test suite with the testthat package and continuous integration with Travis CI (for Linux and macOS) and Appveyor (for Windows).
use_git	logical whether or not to use git version control.
github_auth_token	Provide a personal access token (PAT) from https://github.com/settings/tokens. Defaults to the GITHUB_PAT environment variable. If NULL then only a local git repo is initialized, not a remote GitHub repo.
github_protocol	character string specifying the transfer protocol for pushing the GitHub remote repository , either "ssh" (the default) or "https". Only relevant if github_auth_token is provided.
change_wd	logical whether to change to make the package the working directory upon completion.
...	arguments to pass to methods.

See Also

create github_pat use_news_md use_gpl3_license use_github use_git use_testthat use_travis use_appveyor use_package_doc, init_site

Examples

## Not run: 
# Initialize new package called "mypkg" in the current working directory
init_iqss_package(path = 'mypkg',
                  description = list("Title" = "A Test IQSS Package",
                                     "Description" =
                                     "This is a longer description of the package."))

## End(Not run)

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