aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/gmkin.Rd50
1 files changed, 16 insertions, 34 deletions
diff --git a/man/gmkin.Rd b/man/gmkin.Rd
index f8540ff..751da82 100644
--- a/man/gmkin.Rd
+++ b/man/gmkin.Rd
@@ -1,44 +1,26 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/gmkin.R
\name{gmkin}
\alias{gmkin}
-\title{
- Start a graphical user interface (GUI) based on the \code{gWidgetsWWW2} toolkit.
-}
-\description{
- This function starts a browser based GUI. Please visit the
- \href{http://github.com/jverzani/gWidgetsWWW2}{github page of gWidgetsWWW2}
- for an explanation how this toolkit works.
-}
+\title{Start a graphical user interface (GUI) based on the \code{gWidgetsWWW2} toolkit.}
\usage{
- gmkin(script_name, show.log = FALSE)
+gmkin(script_name, show.log = FALSE)
}
\arguments{
- \item{script_name}{
- During development, a script name with a local working version
- of gmkin can be passed. Defaults to the location of the gmkin.R script
- shipped with the package.
- }
- \item{show.log}{
- During development, it may be useful to see the log of the Rook apps.
- }
-}
-\examples{
- \dontrun{gmkin()} # Start the gmkin GUI
- \dontrun{
- g <- gmkin()
+\item{script_name}{During development, a script name with a local working
+version of gmkin can be passed. Defaults to the location of the gmkin.R
+script shipped with the package.}
- # Only for debugging or other advanced usage:
- session <- gmkin:::get_current_session(g)
- session$p.df
- session$ds.df
- session$ds.cur
- session$m.cur
- session$ws
- }
+\item{show.log}{During development, it may be useful to see the log of the
+Rook apps.}
}
\value{
- The function is called for its side effect, namely starting the GUI in a browser.
- For the curious, the desperate or the adventurous, the gmkin app (a GWidgetsApp object) is returned.
+The function is called for its side effect, namely starting the GUI
+ in a browser. For the curious, the desperate or the adventurous, the gmkin
+ app (a GWidgetsApp object) is returned.
}
-\author{
- Johannes Ranke
+\description{
+This function starts a browser based GUI. Please visit the
+\href{http://github.com/jverzani/gWidgetsWWW2}{github page of gWidgetsWWW2}
+for an explanation how this toolkit works.
}

Contact - Imprint