rpac_all_setup: Setup templates and directories for an R package

In AntonioJBT/Rpacker: Quickly Setup An R Package Using a Devtools Workflow

Setup templates and directories for an R package

Description

rpac_all_setup() creates various directories and files to quickly setup an R package. Includes skeleton structure for code, tests, documentation plus various templates. Various defaults assumed, including templates for GitHub, Travis-CI and Codecov.

Usage

rpac_all_setup(pkg_name = NULL, path = ".", first = NULL,
  last = NULL, email = NULL, pkgs = NULL, github_user = NULL)

Arguments

pkg_name	package name as string
path	Pass a path as string. Default is current working directory ('.').
first	First author name, string
last	Last author name, string
email	Author email for CRAN, string
pkgs	Packages to add to DESCRIPTION, pass as string.
github_user	Pass as string, will be inserted into "https://github.com/github_user/"

Author(s)

Antonio J Berlanga-Taylor <https://github.com/AntonioJBT/Rpacker>

See Also

rpac_create, rpac_rbuildignore, rpac_dependencies, rpac_gitignore, rpac_travis, rpac_cran_comments, rpac_readme, use_package_doc, use_vignette, use_testthat, use_coverage.

Examples

## Not run: 
# Travel to parent directory for setup:
setwd('/somewhere/sensible/like/github_repos/')

# Quick setup for R package directory structure and several templates:
rpac_all_setup(pkg_name = 'packageTest',
               path = '.',
               first = "Super",
               last = "Duper",
               email = "[e-mail]",
               pkgs = 'dummy_holder',
               github_user = 'SuperDuper'
               )


## End(Not run)

AntonioJBT/Rpacker documentation built on Jan. 19, 2025, 2:33 p.m.