iqss_use_readme_rmd: Create README files.

In IQSS/IQSSdevtools: Initialize and Compile Packages Complying with IQSS Best Practices for Software Development and Sustainability

Description

Creates skeleton README files with sections for

• a high-level description of the package and its goals

• R code to install from GitHub, if GitHub usage detected

• a basic example

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. The resulting README is populated with default YAML frontmatter and R fenced code blocks (md) or chunks (Rmd).

Usage

iqss_use_readme_rmd(base_path = ".")

Arguments

base_path

Path to package root.

Source

Modified from usethis

Examples

## Not run: 
iqss_use_readme_rmd()

## End(Not run)

IQSS/IQSSdevtools documentation built on May 8, 2019, 10:54 a.m.