Skip to contents

Generate README with PDF Links

generate_readme.Rd

This function generates a README file with links to all PDF files found in the specified directory. It creates a `README.Rmd` file with the links and then renders it to `README.md`.

Usage

generate_readme(
  ...,
  titles = NULL,
  pdf_dir = "inst/doc",
  readme_rmd = "README.Rmd",
  readme_md = "README.md",
  fileNamesAsLinks = TRUE
)

Arguments

...

Additional arguments passed to the function.

titles

A named list of titles to be used as links in the README file. Default is `NULL`.

pdf_dir

A character string specifying the directory containing the PDF files. Default is "inst/doc".

readme_rmd

A character string specifying the name of the R Markdown file to be created. Default is "README.Rmd".

readme_md

A character string specifying the name of the Markdown file to be generated. Default is "README.md".

A logical value indicating whether to use the titles as links in the README file. Default is `TRUE`.

Value

The function does not return a value. It is called for its side effects of generating the README files.

Examples

if (FALSE) { # \dontrun{
generate_readme()
generate_readme(pdf_dir = "my_docs", readme_rmd = "MyREADME.Rmd", readme_md = "MyREADME.md")
} # }