This function creates a README.Rmd
file at the root of the project based
on a template. Once edited user needs to knit it into a README.md
(or use the function refresh()
).
add_readme_rmd(
type = "package",
given = NULL,
family = NULL,
organisation = NULL,
open = TRUE,
overwrite = FALSE,
quiet = FALSE
)
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.
A character of length 1. The given name of the project maintainer.
A character of length 1. The family name of the project maintainer.
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).
A logical value. If TRUE
(default) the file is opened in the
editor.
A logical value. If this file is already present and
overwrite = TRUE
, it will be erased and replaced. Default is FALSE
.
A logical value. If TRUE
messages are deleted. Default is
FALSE
.
No return value.
Other create files:
add_citation()
,
add_compendium()
,
add_description()
,
add_dockerfile()
,
add_license()
,
add_makefile()
,
add_package_doc()
,
add_renv()
,
add_testthat()
,
add_vignette()
if (FALSE) {
add_readme_rmd(type = "package")
}