collect_roxygen: Collects and Generates documentation of a package in a tibble...

In fabR: Wrapper Functions Collection Used in Data Pipelines

Collects and Generates documentation of a package in a tibble format.

Description

This function crawls and aggregates roxygen documentation into a tibble format. To work properly, elements must be separated with the named fields at title, at description, at ...), each at will be used as column name. The column name will also have 80 character to show the margin limit of each chunk of documentation.

Usage

collect_roxygen(folder_r = "R")

Arguments

folder_r

A character string identifying the folder to index. If not specified, 'R/' is the default.

Value

A tibble where each line represents a function described in a package, and each column is documentation field. Most common fields (title, description, details, param, see also, return and examples are placed ahead).

Examples

{

library(tidyr)
try({tibble(collect_roxygen(tempfile()))}, silent = FALSE)

}

fabR documentation built on May 29, 2024, 2:58 a.m.