View mixKernel User's Guide — mixKernel.users.guide • mixKernel

Find the location of the mixKernel User's Guide and optionnaly opens it

mixKernel.users.guide(html = TRUE, view = html)

Arguments

html: logical. Should the document returned by the function be the compiled PDF or the Rmd source. Default to TRUE
view: logical. Should the document be opened using the default HTML viewer? Default to html. It has no effect if html = FALSE

Value

Character string giving the file location. If html = TRUE and view = TRUE, the HTML document reader is started and the User's Guide is opened in it.

Details

If the operating system is not Windows, then the HTML viewer used is that given by Sys.getenv("R_BROWSER"). The HTML viewer can be changed using Sys.setenv(R_BROWSER = ).

Author

Jerome Mariette <jerome.mariette@inrae.fr> Nathalie Vialaneix <nathalie.vialaneix@inrae.fr>

Examples

mixKernel.users.guide(view = FALSE)
#> [1] ""
mixKernel.users.guide(html = FALSE)
#> [1] ""
if (FALSE) mixKernel.users.guide()