documentation {rdocumentation} R Documentation

make documentation for a R# function or symbol

Description

Usage

documentation(func,
    template = NULL,
    desc = NULL);

Arguments

func

the specific R# function or symbol

template

the html template string. [as string]

desc

the package DESCRIPTION metadata for the R# symbol if the given `func` object is a kind of the R source code Document object. [as DESCRIPTION]

env

[as Environment]

Details

Authors

roxygenNet

Value

this function returns data object of type string.

clr value class

Examples

[Package rdocumentation version 1.0.0.0 Index]