setup_package: Build package infrastructure from template and configuration...

Description Usage Arguments Details Value Examples

View source: R/setup_package.R

Description

Bootstrap package creation

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
setup_package(
  pkg_name = NULL,
  project_dir = NULL,
  config_file = NULL,
  option_name = "luciolib",
  use_cc = TRUE,
  ci_suite = TRUE,
  is_private = TRUE,
  branch = "main",
  remote_user = NULL
)

Arguments

pkg_name

Package name to be created

project_dir

package project path to be used

config_file

path to configuration file used. Default: NULL

option_name

Option slot to query for description. Default: "luciolib"

use_cc

Should be added a Code of Conduct, Default: TRUE

ci_suite

Add CI infrastructure, Default: FALSE

is_private

create private GitHub repo, Default: FALSE

branch

name of the default git branch to create. Default: "main"

remote_user

name of the user / organization to host the remote repo

Details

DETAILS

Value

Boolean; TRUE if it package was created successfully

Examples

1
2
3
4
5
6
## Not run: 
if (interactive()) {
  setup_package(pkg_name = "testPkg", project_dir = fs::path_temp())
}

## End(Not run)

luciorq/luciolib documentation built on Dec. 18, 2020, 11:43 a.m.