render_readme: Render README.Rmd for Github

In petrbouchal/ptrr: Personal utilities

Render README.Rmd for Github

Description

Useful when inside a Markdown website. Wrapper around 'rmarkdown::render'.

Usage

render_readme(
  path = "README.Rmd",
  output_format = "github_document",
  output_file = NULL,
  ...
)

Arguments

path	path to file. Default is "README.Rmd"
output_format	output format passed to 'rmarkdown::render'. Defaults to "github_document".
output_file	output format passed to 'rmarkdown::render'. Defaults to "filename.md".
...	Passed to 'rmarkdown::render()'

Value

RETURN_DESCRIPTION

Examples

# ADD_EXAMPLES_HERE

petrbouchal/ptrr documentation built on Oct. 10, 2024, 7:21 a.m.