add_readme_rmd: Create a README file

Description Usage Arguments Value See Also Examples

View source: R/add_readme_rmd.R

Description

This function creates a README.Rmd file at the root of the project based on a template (adapted from usethis). Once edited user needs to knit it into a README.Rmd (or use the function refresh()).

Usage

1
2
3
4
5
6
7
8
9
add_readme_rmd(
  type = "package",
  given = NULL,
  family = NULL,
  organisation = NULL,
  open = TRUE,
  overwrite = FALSE,
  quiet = FALSE
)

Arguments

type

a character of length 1

If package (default) a GitHub README.Rmd specific to an R package will be created. If compendium a GitHub README.Rmd specific to a research compendium will be created.

given

a character of length 1

The given name of the package maintainer.

family

a character of length 1

The family name of the package maintainer.

organisation

a character of length 1

The name of the GitHub organisation to host the package. If NULL (default) the GitHub account will be used. This argument is used to set the URL of the package (hosted on GitHub).

open

a logical value

If TRUE (default) the file is opened in the editor.

overwrite

a logical value

If this file is already present and overwrite = TRUE, it will be erased and replaced. Default is FALSE.

quiet

a logical value

If TRUE messages are deleted. Default is FALSE.

Value

None

See Also

Other create files: add_citation(), add_compendium(), add_description(), add_license(), add_makefile(), add_package_doc(), add_testthat(), add_vignette()

Examples

1
2
3
4
## Not run: 
add_readme_rmd(type = "package")

## End(Not run)

rcompendium documentation built on March 24, 2021, 5:06 p.m.