modules (version 0.9.8)

module_help: Display module documentation

Description

module_help displays help on a module<U+2019>s objects and functions in much the same way help does for package contents.

Usage

module_help(topic, help_type = getOption("help_type", "text"))
# ?module$function
# help(module$function)

Arguments

topic

fully-qualified name of the object or function to get help for, in the format module$function

help_type

character string specifying the output format; currently, only 'text' is supported

Examples

# NOT RUN {
mod = import('mod')
module_help(mod$func)
# }
# NOT RUN {
?mod$func
# }
# NOT RUN {
help(mod$func)
# }