display8tags: returns the contents of a 'tags' object
In documair: Automatic Documentation for R packages
Description
Usage
Arguments
Details
Value
Future
Description
Typically, tags is either documair0$tags or
documair0$tgs which defines the tagging of the R code
to introduce the documentation to be tackled by /documair/.
Such a function is provided to help the user in seeing the
present constants, and possibly to change their value.
Usage
1
2
3
display8tags(tags=documair0$tags,
what="values",imp=FALSE)
Arguments
tags
List to be displayed.
what
a character(1) indicating what must be returned. The acceptable values are names, definitions, usage, content, preparation, title and values. For user convenience, the argument is lowercased before checked, and only the first character is taken into consideration.
imp
indicates if an adapted printing of the results must be done.
Details
More details on the possibilities offered with argument what
are obtained into documair0$tags$d.
Value
A character or a list according to what
Future
Make an equivalent function to change the tags values
documair documentation built on May 2, 2019, 5:20 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Details Value Future
Description
Typically, tags is either documair0$tags or
documair0$tgs which defines the tagging of the R code
to introduce the documentation to be tackled by /documair/.
Such a function is provided to help the user in seeing the
present constants, and possibly to change their value.
Usage
1 2 3 |
display8tags(tags=documair0$tags,
what="values",imp=FALSE)
|
Arguments
tags |
List to be displayed. |
what |
a character(1) indicating what must be returned. The acceptable values are names, definitions, usage, content, preparation, title and values. For user convenience, the argument is lowercased before checked, and only the first character is taken into consideration. |
imp |
indicates if an adapted printing of the results must be done. |
Details
More details on the possibilities offered with argument what are obtained into documair0$tags$d.
Value
A character or a list according to what
Future
Make an equivalent function to change the tags values
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.