build_readme: Build README

In memoiR: R Markdown and Bookdown Templates to Publish Documents

Build README

Description

Build a README.md file that will be used as index of GitHub Pages.

Usage

build_readme(PDF = TRUE)

Arguments

PDF	if TRUE (by default), a link to the PDF output is added.

Details

R Markdown files of the project are used to get the title and abstract of the published documents. Run this function once in each project created from a memoiR template, before build_githubpages(). A link to their HTML and, optionally, PDF versions is added. Metadata fields are read in the .Rmd files YAML header: title, abstract and URL.

Value

The content of the README.md file as a vector of characters, invisibly. Each element is a line of the file.

Examples

## Simulate the creation of a new project
# Save working directory
original_wd <- getwd()
# Get a temporary working directory
wd <- tempfile("example")
# Simulate File > New File > R Markdown... > From Template > Simple Article
rmarkdown::draft(wd, template="simple_article", package="memoiR", edit=FALSE)
# Go to temp directory
setwd(wd)
# Make it the current project
usethis::proj_set(path = ".", force = TRUE)

# Build README.md file
build_readme()
# Content
readLines("README.md")

## End of the example: cleanup
# Return to the original working directory and clean up
setwd(original_wd)
unlink(wd, recursive=TRUE)

memoiR documentation built on Sept. 14, 2023, 5:06 p.m.