format_fct_ref: Produces index string for pkg::function

View source: R/format.R

format_fct_refR Documentation

Produces index string for pkg::function

Description

Formats package as 'pkg' and, when called the first time, adds reference as [@R-pkg]

Usage

format_fct_ref(pkg, this_fct, force_index = TRUE, force_pkg = FALSE)

Arguments

pkg

a pkg availabe locally or github

this_fct

name of function

force_index

Logical (TRUE or FALSE) - defines whether to force formal reference (e.g. [@R-pkg])

force_pkg

force citation of package? TRUE|FALSE

Value

a string in rmarkdown

Examples

format_fct_ref("dplyr", "group_by")

msperlin/vdr documentation built on Nov. 25, 2022, 2:29 a.m.