vExplorer {tkWidgets} | R Documentation |
An interface to interact with vignette code chunks
Description
This function provides a widget for viewing, editing, and executing code chunks of vignettes.
Usage
vExplorer(title = "BioC Vignettes Explorer", pkgName = "", font =
ifelse(.Platform$OS.type == "unix", "arial 14", "arial 11"))
viewVignette(title, packName, vigPath, font = "arial 11")
Arguments
title |
character string for the name to be displayed as the title of the widget to interact with code chunks. |
pkgName |
vector (of length 1 for |
packName |
same as pkgName |
vigPath |
character string for the full qualified name of a vignette to be explored. |
font |
a character string for the name and size of the font to be used for text rendered on the widgets (e. g. "arial 11") |
Details
By default, packNames = ""
, all the installed packages will be
examined and those that have vignettes will be listed to allow users
to choose from.
Value
This function does not return any useful value.
Note
This function is part of the Bioconductor project at Dana-Faber Cancer Institute to provide Bioinformatics functionalities through R.
Author(s)
Jianhua Zhang
References
Examples
if(interactive()){
require("DynDoc", character.only = TRUE)
require("tools", character.only = TRUE)
require("widgetTools", character.only = TRUE)
vExplorer()
path <- path.package("widgetTools")
vigList <- pkgVignettes("widgetTools")
viewVignette("BioC VignetteBrowser", "widgetTools", vigList$docs)
}