update_readme: Update 'README.md'
In PetterHopp/NVIpackager: Tools to facilitate Development of NVIverse Packages

update_readme

R Documentation

Update `README.md`

Description

Update README.md from README.Rmd and child templates in NVIpackager. If the file don't exist, it is created.

Usage

update_readme(
  pkg = stringi::stri_extract_last_words(usethis::proj_path()),
  pkg_path = usethis::proj_path()
)

Arguments

`pkg`	[`character(1)`] The package name. Defaults to `stringi::stri_extract_last_words(usethis::proj_path())`.
`pkg_path`	[`character(1)`] The path to the package directory. Defaults to `usethis::proj_path()`.

Details

The child templates are found in NVIpackager. Any change in this text must be done in the templates.

Value

None. Writes the file README.md.

Author(s)

Petter Hopp Petter.Hopp@vetinst.no

Examples

## Not run: 
# Attach packages and set up with temporary directory
library(NVIpackager)
td <- tempdir()
if (!dir.exists(file.path(td, "NVItest"))) {
  dir.create(file.path(td, "NVItest"))
}

update_readme(pkg = "NVItest",
              pkg_path = file.path(td, "NVItest"))

## End(Not run)

PetterHopp/NVIpackager documentation built on Sept. 14, 2024, 1:24 a.m.