Description Usage Arguments Details See Also Examples
Output the docstring info of a module.
1 2 3 4 | print_info(name = .Last.name, line_numbers = F, sep = "\n",
load = TRUE)
info(name = .Last.name, line_numbers = F, sep = "\n", load = TRUE)
|
name |
A string (character vector of lenght one). A module name can contain letters, figures and some special characters,
namely Names containing The name "modulr" corresponds to a special module and is therefore reserved. |
line_numbers |
A flag. Should the source line numbers be outputed? |
sep |
A string (character vector of length one) containing the separator between docstrings blocs. |
load |
A flag. Should the module be loaded? |
A docstring is intended to document a module and provide the user
with the ability to inspect it at run time, for instance as an interactive
help system, or as metadata. Formally, it is a block of commented lines
prefixed with #'
and located at the top of the module provider.
The preferred formatting for a docstring is R Markdown, notabely for Modulr
Gears (see prepare_gear
).
define
, prepare_gear
, and
reset
.
1 2 3 4 5 6 7 8 9 10 11 12 |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.