dot-limitations: .limitations

.limitationsR Documentation

.limitations

Description

helper function which adds a "limitations" section.

Usage

.limitations(zz, limitations, emptyIfNULL = FALSE)

Arguments

zz

a connection object of class "textConnection" containing the markdown document

limitations

A character vector containing the given limitations

emptyIfNULL

switch which decides whether limitations section should be ignored, if limitations input is NULL or if it should state that there are no known limitations.

Author(s)

Jan Philipp Dietrich

See Also

goxygen, createModulePage


pik-piam/goxygen documentation built on Feb. 1, 2024, 5:35 p.m.