Create a default package skeleton
use_grk_starter_package( path, github = TRUE, github_org = NULL, github_private = FALSE, open = TRUE, title = "What the Package Does (One Line, Title Case)", description = "What the package does (one paragraph)" )
path | Path (and thus package name) where the package will be stored |
---|---|
github | Should a github repository be created? |
github_org | The organization where the repo should be created. If
unspecified (or |
github_private | Should the GitHub repo be private? |
open | Should the package be opened? If |
title | Package title: "What the Package Does (One Line, Title Case)" |
description | Package description: "What the package does (one paragraph)" |
See usethis::use_description()
for information about setting your default
package DESCRIPTION file fields. The help file there provides an example of
how to set "usethis.description"
in your .Rprofile
.