Description Usage Arguments Value Octave Documentation for help Octave Documentation for doc Examples
View source: R/base-functions.R
o_help
retrieves the Octave help page associated with a given symbol.
By default the page is printed out, but may also be silently retrieved or
formatted for direct inclusion in R documentation files (i.e. Rd files).
o_doc
displays documentation for the function FUNCTION_NAME directly
from an on-line version of the printed manual, using the GNU Info browser.
Type 'q' to quit the browser.
1 2 3 4 |
NAME |
Octave symbol (e.g. command, function, operator) passed to Octave
function |
character.only |
a logical indicating whether |
show |
logical that specifies if the help page should be shown using the
as R documentation file (default), e.g. using a pager, or only returned as a
single string. Note that when |
format |
a specification of the output format.
If |
FUNCTION_NAME |
the name of the function from which to show the documentation. See the relevant Octave Documentation section below. |
this function is usually called for its side effect of printing the
help page on standard output (argument show=TRUE
), but it invisibly
returns the help page as a single character string.
[Generated from Octave-\Sexpr{RcppOctave::o_version()} on \Sexpr{Sys.time()}]
[Generated from Octave-\Sexpr{RcppOctave::o_version()} on \Sexpr{Sys.time()}]
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | o_help(print)
o_help(rand)
# or equivalently
o_help('rand')
# to include in Rd files, use argument rd=TRUE in an \Sexpr:
## Not run:
\Sexpr[results=rd,stage=render]{RcppOctave::o_help(rand, format='rd')}
## End(Not run)
# to see the included Rd code
o_help(rand, format=TRUE)
o_help(rand, format='HTML')
o_help(rand, format='latex')
try({ # may throw an error if Octave documentation is not installed
o_doc(text)
# or equivalently
o_doc('text')
})
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.