make_README: Generates README.md from *.rmd package documentation.

In mwrowe/microRutils: Mike Rowe's Miscellaneous R Utility Functions

Description

make_README() is a utility to generate a README.md file from microRutils.R by converting the R markdown to GitHub-friendly markdown.

Usage

make_README(pkg.R_file, out.file)

Arguments

pkg.R_file	character value specifying file path/name to be converted.
out.file	optional character value specifying file path/name for output *.md file.

Details

Might be reusable, but meant for internal use (Not exported). Caveat emptor; hasn't been tested much. If you really want to try it, use microRutils:::make_README.R().

Value

Invisibly returns a character vector with the output, one line per row.

Author(s)

M.W.Rowe, [e-mail]

mwrowe/microRutils documentation built on June 12, 2021, 2:41 p.m.