R Graphical Manual

Browse All

Last data update: 2014.03.03

R: A widget that allows users to explore the example code and...

eExplorer

R Documentation

A widget that allows users to explore the example code and help files of a given R package

Description

Given a valid package name as a character string, eExplorer collects all the example code from the "R-ex" directory from the R library for that package and then displays the names of the code examples in a list box. When a name in the list box is clicked, the corresponding code will be displayed and users are allowed to execute the code or view the help file for the function the example code is for.

Usage

eExplorer(pkgName, font = "arial 13", getFocus = TRUE)
getExCode(pkgName)
getHelpFile(pkgName, fileName)

Arguments

`pkgName`	`pkgName` a character string for the name of an R package of interest. The R package needs to be installed
`font`	`font` a character string for the font to be used by the widget to display the text. The default is "arial 13"
`fileName`	`fileName` a character string for the name of a file in "R-ex" with the ".R" extension removed. The file contains a chunk of example code and may have a corrsponding help file in the "help" directory
`getFocus`	`getFocus` a boolean indicating whether a widget should grab the focus

Details

getExCode and getHelpFile are called by eExplorer to get the code examples or help help files contained by a given package.

Value

eExplorer does not return anything useful.

Author(s)

Jianhua Zhang

References

Writing R Extension for information on "R-ex" and "help" directories

Examples

  if(interactive()){
      require("Biobase") || stop("Does not run without Biobase")
      eExplorer("Biobase")
  }

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(tkWidgets)
Error in library(tkWidgets) : there is no package called 'tkWidgets'
Execution halted