Skip to contents

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

if (FALSE) {
readme('test project',getwd(),'report')
}