[rkward-cvs] SF.net SVN: rkward:[3849] trunk/rkward/rkward/rbackend/rpackages/rkwarddev

m-eik at users.sourceforge.net m-eik at users.sourceforge.net
Tue Sep 27 14:36:44 UTC 2011 

Revision: 3849
          http://rkward.svn.sourceforge.net/rkward/?rev=3849&view=rev
Author:   m-eik
Date:     2011-09-27 14:36:43 +0000 (Tue, 27 Sep 2011)
Log Message:
-----------
rkwarddev: updated docs

Modified Paths:
--------------
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/DESCRIPTION
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rkwarddev-package.R
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.dialog.Rd
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.page.Rd
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.plugin.Rd
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.tabbook.Rd
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.vars.Rd
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.wizard.Rd
    trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rkwarddev-package.Rd

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/DESCRIPTION
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/DESCRIPTION	2011-09-27 14:09:15 UTC (rev 3848)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/DESCRIPTION	2011-09-27 14:36:43 UTC (rev 3849)
@@ -15,7 +15,7 @@
 Authors at R: c(person(given="Meik", family="Michalke",
     email="meik.michalke at hhu.de", role=c("aut", "cre")))
 Version: 0.02-0
-Date: 2011-09-26
+Date: 2011-09-27
 Collate:
     'rk-internal.R'
     'rk.JS.array.R'

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rkwarddev-package.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rkwarddev-package.R	2011-09-27 14:09:15 UTC (rev 3848)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/R/rkwarddev-package.R	2011-09-27 14:36:43 UTC (rev 3849)
@@ -4,7 +4,7 @@
 #' Package: \tab rkwarddev\cr
 #' Type: \tab Package\cr
 #' Version: \tab 0.02-0\cr
-#' Date: \tab 2011-09-26\cr
+#' Date: \tab 2011-09-27\cr
 #' Depends: \tab R (>= 2.9.0),XiMpLe,rkward\cr
 #' Enhances: \tab rkward\cr
 #' Encoding: \tab UTF-8\cr

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.dialog.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.dialog.Rd	2011-09-27 14:09:15 UTC (rev 3848)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.dialog.Rd	2011-09-27 14:36:43 UTC (rev 3849)
@@ -2,11 +2,14 @@
 \alias{rk.XML.dialog}
 \title{Create XML dialog section for RKWard plugins}
 \usage{
-  rk.XML.dialog(nodes)
+  rk.XML.dialog(nodes, label = NULL)
 }
 \arguments{
   \item{nodes}{A (list of) objects of class
   \code{XiMpLe.node}.}
+
+  \item{label}{Character string, a text label for this
+  plugin element.}
 }
 \value{
   A list of objects of class \code{XiMpLe.node}.

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.page.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.page.Rd	2011-09-27 14:09:15 UTC (rev 3848)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.page.Rd	2011-09-27 14:36:43 UTC (rev 3849)
@@ -2,11 +2,14 @@
 \alias{rk.XML.page}
 \title{Create XML page node for RKWard plugins}
 \usage{
-  rk.XML.page(nodes)
+  rk.XML.page(nodes, id.name = NULL)
 }
 \arguments{
   \item{nodes}{A (list of) objects of class
   \code{XiMpLe.node}.}
+
+  \item{id.name}{Character string, a unique ID for this
+  plugin element.}
 }
 \value{
   A list of objects of class \code{XiMpLe.node}.

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.plugin.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.plugin.Rd	2011-09-27 14:09:15 UTC (rev 3848)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.plugin.Rd	2011-09-27 14:36:43 UTC (rev 3849)
@@ -2,16 +2,13 @@
 \alias{rk.XML.plugin}
 \title{Create XML document for RKWard plugins}
 \usage{
-  rk.XML.plugin(name, label, dialog = NULL, wizard = NULL,
-  logic = NULL, provides = c("logic", "dialog"), help =
-  TRUE, pluginmap = NULL)
+  rk.XML.plugin(name, dialog = NULL, wizard = NULL, logic =
+  NULL, provides = c("logic", "dialog"), help = TRUE,
+  pluginmap = NULL, label = NULL)
 }
 \arguments{
   \item{name}{Character string, the name of the plugin.}
 
-  \item{label}{Character string, a text label for the
-  plugin's top level, i.e. the window title of the dialog.}
-
   \item{dialog}{An object of class \code{XiMpLe.node} to be
   pasted as the \code{<dialog>} section (but only if
   \code{provides} includes \code{"dialog"} as well). See
@@ -44,6 +41,11 @@
   \item{pluginmap}{Character string, relative path to the
   pluginmap file, which will then be included in the head
   of this document.}
+
+  \item{label}{Character string, a text label for the
+  plugin's top level, i.e. the window title of the dialog.
+  Will only be used if \code{dialog} or \code{wizard} are
+  \code{NULL}.}
 }
 \value{
   An object of class \code{XiMpLe.doc}.

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.tabbook.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.tabbook.Rd	2011-09-27 14:09:15 UTC (rev 3848)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.tabbook.Rd	2011-09-27 14:36:43 UTC (rev 3849)
@@ -2,12 +2,12 @@
 \alias{rk.XML.tabbook}
 \title{Create XML node "tabbook" for RKWard plugins}
 \usage{
-  rk.XML.tabbook(label, tab.labels, children = list(),
-  id.name = "auto")
+  rk.XML.tabbook(label = NULL, tab.labels, children =
+  list(), id.name = "auto")
 }
 \arguments{
   \item{label}{Character string, a text label for this
-  plugin element.}
+  plugin element. Must be set if \code{id.name="auto"}.}
 
   \item{tab.labels}{Character vector, where each string
   defines the name of one tab. The number of

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.vars.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.vars.Rd	2011-09-27 14:09:15 UTC (rev 3848)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.vars.Rd	2011-09-27 14:36:43 UTC (rev 3849)
@@ -5,8 +5,8 @@
   rk.XML.vars(label, slot.text, required = FALSE, multi =
   FALSE, min = 1, any = 1, max = 0, dim = 0, min.len = 0,
   max.len = NULL, classes = NULL, types = NULL, horiz =
-  TRUE, add.nodes = NULL, frame.label = NULL, id.name =
-  "auto")
+  TRUE, add.nodes = NULL, frame.label = NULL,
+  formula.dependent = NULL, id.name = "auto")
 }
 \arguments{
   \item{label}{Character string, a text label for the
@@ -60,9 +60,19 @@
   \item{frame.label}{Character string, a text label for the
   whole frame.}
 
+  \item{formula.dependent}{Character string, if not
+  \code{NULL} will cause the addition of a second varslot
+  for the dependent variable(s), using the text of
+  \code{formula.dependent} as the label. Also a
+  \code{<formula>} node will be added, using both varslots
+  for \code{fixed_factors} and \code{dependent}
+  respectively.}
+
   \item{id.name}{Character vector, unique IDs for the frame
   (first entry), the varselector (second entry) and varslot
-  (third entry). If \code{"auto"}, IDs will be generated
+  (third entry). If \code{formula.dependent} is not
+  \code{NULL}, a fourth entry is needed for the formula
+  node as well. If \code{"auto"}, IDs will be generated
   automatically from \code{label} and \code{slot.text}.}
 }
 \value{

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.wizard.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.wizard.Rd	2011-09-27 14:09:15 UTC (rev 3848)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rk.XML.wizard.Rd	2011-09-27 14:36:43 UTC (rev 3849)
@@ -2,11 +2,14 @@
 \alias{rk.XML.wizard}
 \title{Create XML wizard section for RKWard plugins}
 \usage{
-  rk.XML.wizard(nodes)
+  rk.XML.wizard(nodes, label = NULL)
 }
 \arguments{
   \item{nodes}{A (list of) objects of class
-  \code{XiMpLe.node}.}
+  \code{XiMpLe.node}}
+
+  \item{label}{Character string, a text label for this
+  plugin element.}
 }
 \value{
   A list of objects of class \code{XiMpLe.node}.

Modified: trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rkwarddev-package.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rkwarddev-package.Rd	2011-09-27 14:09:15 UTC (rev 3848)
+++ trunk/rkward/rkward/rbackend/rpackages/rkwarddev/man/rkwarddev-package.Rd	2011-09-27 14:36:43 UTC (rev 3849)
@@ -9,7 +9,7 @@
 \details{
   \tabular{ll}{ Package: \tab rkwarddev\cr Type: \tab
   Package\cr Version: \tab 0.02-0\cr Date: \tab
-  2011-09-26\cr Depends: \tab R (>= 2.9.0),XiMpLe,rkward\cr
+  2011-09-27\cr Depends: \tab R (>= 2.9.0),XiMpLe,rkward\cr
   Enhances: \tab rkward\cr Encoding: \tab UTF-8\cr License:
   \tab GPL (>= 3)\cr LazyLoad: \tab yes\cr URL: \tab
   http://rkward.sourceforge.net\cr }

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

More information about the rkward-tracker mailing list