init_docs: Initialize documentation files for an R package, including...

Description Usage Arguments Value Examples

Description

Initialize documentation files for an R package, including tests, license, news, and roxygen markdown.

Usage

1
2
init_docs(auth_name = "Frank Farach", testthat = TRUE,
  license = TRUE, news = TRUE, roxygen_md = TRUE)

Arguments

auth_name

Character string naming the package author

testthat

Logical flag indicating whether to include testing

license

Logical flag indicating whether to include a LICENSE file

news

Logical flag indicating whether to include NEWS.md

roxygen_md

Logical flag indicating whether to use the roxygen_md package

Value

The return values depend on the flags that are TRUE.

Examples

1
2
3
4
## Not run: 
init_docs()

## End(Not run)

frankfarach/frankr documentation built on June 9, 2019, 11:40 a.m.