use_readme_rmd

0th

Percentile

Create README files.

Use Rmd if you want a rich intermingling of code and data. Use md for a basic README. README.Rmd will be automatically added to .Rbuildignore.

Usage
use_readme_rmd(pkg = ".")

use_readme_md(pkg = ".")

Arguments
pkg
package description, can be path or package name. See as.package for more information
See Also

Other infrastructure: infrastructure, use_build_ignore, use_data_raw, use_data, use_news_md, use_package

Aliases
  • use_readme_md
  • use_readme_rmd
Documentation reproduced from package devtools, version 1.11.1, License: GPL (>= 2)

Community examples

Looks like there are no examples yet.