readme: Project README

In jasenfinch/projecttemplates: Project Templates for Reproducible Research and Analyses

Project README

Description

Export a README to a project directory

Usage

readme(project_name, path, type = projectTypes(), renv = TRUE)

Arguments

project_name	project name/title
path	target file path for project directory
type	project type. Should be one returned by projectTypes().
renv	add text for renv support

Examples

## Not run: 
readme('test project',getwd(),'report')

## End(Not run)

jasenfinch/projecttemplates documentation built on July 30, 2023, 5:28 a.m.