Skip to contents

Extract the YAML front matter and 'description' line from an analysis notebook, and construct a URL to the notebook's location on GitHub pages.

Usage

rmd_metadata(file_path)

Arguments

file_path

Path to analysis notebook

Value

Named list containing analysis notebook title, URL, date, and description

Details

The 'description' line is the the first non-blank line in the body of an R notebook that serves as a brief description of the work.

If _quarto.yml is present, rmd_metadata() will extract the YAML front matter and description from Quarto format (.qmd) notebooks.