scrape_roxygen: Scrape Roxygen blocks

In phuse-org/valtools: Automate Validated Package Creation

Scrape Roxygen blocks

Description

valtools uses roxygen across multiple file types to provide documentation. this function provides the tooling necessary to scrape from the major file types that we use ( R, R test code, markdown, Rmarkdown) and provides a consistent output type to capture the information necessary to help high level functions make assumptions.

Usage

scrape_roxygen(file, ..., type = tools::file_ext(file))

Arguments

file	file to scrape roxygen block from
...	These dots are for future extensions and must be empty.
type	method of parse_roxygen to use if other that file extension

Value

a list of roxygen blocks found in the file.

phuse-org/valtools documentation built on Nov. 10, 2024, 1:36 a.m.