show_documentation: Show package documentation
In ing-bank/tsforecast: Time Series Forecasting Pipeline
Description
Usage
Arguments
Value
Examples
View source: R/HELPER_show_documentation.R
Description
show_documentation is a function to open the documentation (available
as html file) in a browser.
Usage
1
show_documentation(topic = c("README", "forecast_models"), test_mode = F)
Arguments
topic
A character string indicating which of the available
documentation files to display.
test_mode
Boolean, which is only set to TRUE when testing this
function within the testthat framework for building the tsforecast
package.
Value
An html document with documentation.
Examples
1
ing-bank/tsforecast documentation built on Sept. 18, 2020, 9:40 a.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 Value Examples
View source: R/HELPER_show_documentation.R
Description
show_documentation is a function to open the documentation (available
as html file) in a browser.
Usage
1 | show_documentation(topic = c("README", "forecast_models"), test_mode = F)
|
Arguments
topic |
A character string indicating which of the available documentation files to display. |
test_mode |
Boolean, which is only set to TRUE when testing this function within the testthat framework for building the tsforecast package. |
Value
An html document with documentation.
Examples
1 |
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.