alval_flow: Generates an R package

In avalcarcel9/aliviateR: A package to automate my R workflow

Description

Generates an R package according to Ali Valcarcel's workflow. This essentially wraps the usethis package functions that I always use when creating an R package

Usage

alval_flow(
  path = NULL,
  pkg_name = NULL,
  vignette_name = NULL,
  testing = TRUE,
  data = TRUE,
  title = "What the Package Does (One Line, Title Case)",
  description = "What the package does (one paragraph).",
  firstname = "Alessandra",
  lastname = "Valcarcel",
  email = "[e-mail]",
  role = c("aut", "cre")
)

Arguments

path	Path where you will be storing your package
pkg_name	Name of package you are creating
vignette_name	NULL or name of vignette file to be generated. NULL by default will not generate a vignette or associated files
testing	FALSE by default. Logical for building testing material through usethis
data	TRUE by default. Logical for adding data to package structure.
title	Package title to be put in description
description	Description to be put in description
firstname	First name. Defaults to my first name
lastname	Last name. Defaults to my last name
email	Email. Defaults to my email.
role	Default is author and creator

Value

Folder in specified R path with R package related objects. Vignette may be opened if specified.

Examples

## Not run: 
alval_flow(path = '/Users/alval/Desktop',
pkg_name = "test",
vignette_name = NULL,
testing = FALSE,
data = TRUE
title = "What the Package Does (One Line, Title Case)",
description = "What the package does (one paragraph).",
firstname = "Alessandra (Ali)",
middlename = "M.",
lastname = "Valcarcel",
email = "[e-mail]",
role = c("aut", "cre"))
## End(Not run)

avalcarcel9/aliviateR documentation built on July 10, 2020, 12:32 p.m.