rmd_metadata: Get analysis notebook metadata

View source: R/to_document.R

rmd_metadataR Documentation

Get analysis notebook metadata

Description

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

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.

Value

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


jabenninghoff/rdev documentation built on March 18, 2023, 9:31 p.m.