Render README.Rmd for Github — render

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

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()`

RETURN_DESCRIPTION

# ADD_EXAMPLES_HERE