devtools (version 1.10.0)

use_readme_rmd: Use README.Rmd

Description

This creates `README.Rmd` from template and adds to .Rbuildignore.

Usage

use_readme_rmd(pkg = ".")

Arguments

pkg

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

hook

Hook name. One of "pre-commit", "prepare-commit-msg", "commit-msg", "post-commit", "applypatch-msg", "pre-applypatch", "post-applypatch", "pre-rebase", "post-rewrite", "post-checkout", "post-merge", "pre-push", "pre-auto-gc".

script

Text of script to run

See Also

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