documair (version 0.6-0)

display8tags: returns the contents of a 'tags' object

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

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.

Value

A character or a list according to what

Future

Make an equivalent function to change the tags values

Details

More details on the possibilities offered with argument what are obtained into documair0$tags$d.