devtools (version 1.8.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: add_build_ignore, use_build_ignore; add_rstudio_project, add_test_infrastructure, add_test_infrastructure, add_travis, add_travis, add_travis, add_travis, infrastructure, use_appveyor, use_code_of_conduct, use_coveralls, use_cran_badge, use_cran_comments, use_package_doc, use_rcpp, use_revdep, use_rstudio, use_test, use_testthat, use_travis, use_vignette; use_data_raw; use_data; use_package