[rkward-cvs] SF.net SVN: rkward-code:[4961] trunk/rkward/packages/rkwarddev
m-eik at users.sf.net
m-eik at users.sf.net
Sun Oct 26 19:10:55 UTC 2014
Revision: 4961
http://sourceforge.net/p/rkward/code/4961
Author: m-eik
Date: 2014-10-26 19:10:53 +0000 (Sun, 26 Oct 2014)
Log Message:
-----------
rkwarddev: fixed some copy&paste bugs, added support for "allow_duplicates" (varslot/valueslot) and let roxygen clean the docs
Modified Paths:
--------------
trunk/rkward/packages/rkwarddev/ChangeLog
trunk/rkward/packages/rkwarddev/R/rk.XML.valueslot.R
trunk/rkward/packages/rkwarddev/R/rk.XML.varslot.R
trunk/rkward/packages/rkwarddev/inst/CITATION
trunk/rkward/packages/rkwarddev/inst/NEWS.Rd
trunk/rkward/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf
trunk/rkward/packages/rkwarddev/man/echo.Rd
trunk/rkward/packages/rkwarddev/man/i18n.Rd
trunk/rkward/packages/rkwarddev/man/id.Rd
trunk/rkward/packages/rkwarddev/man/ite.Rd
trunk/rkward/packages/rkwarddev/man/join.Rd
trunk/rkward/packages/rkwarddev/man/qp.Rd
trunk/rkward/packages/rkwarddev/man/rk.JS.array.Rd
trunk/rkward/packages/rkwarddev/man/rk.JS.doc.Rd
trunk/rkward/packages/rkwarddev/man/rk.JS.options.Rd
trunk/rkward/packages/rkwarddev/man/rk.JS.optionset.Rd
trunk/rkward/packages/rkwarddev/man/rk.JS.saveobj.Rd
trunk/rkward/packages/rkwarddev/man/rk.JS.scan.Rd
trunk/rkward/packages/rkwarddev/man/rk.JS.vars.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.about.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.components.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.dependencies.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.dependency_check.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.formula.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.frame.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.matrix.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.option.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.optioncolumn.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.optionset.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.pluginmap.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.radio.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.require.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.saveobj.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.select.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.set.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.snippets.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.spinbox.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.switch.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.values.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.valueselector.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.valueslot.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.vars.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.varslot.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.wizard.Rd
trunk/rkward/packages/rkwarddev/man/rk.build.plugin.Rd
trunk/rkward/packages/rkwarddev/man/rk.get.rkh.prompter.Rd
trunk/rkward/packages/rkwarddev/man/rk.paste.JS.Rd
trunk/rkward/packages/rkwarddev/man/rk.paste.JS.graph.Rd
trunk/rkward/packages/rkwarddev/man/rk.plotOptions.Rd
trunk/rkward/packages/rkwarddev/man/rk.plugin.component.Rd
trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.doc.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.scan.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.settings.Rd
trunk/rkward/packages/rkwarddev/man/rk.set.comp.Rd
trunk/rkward/packages/rkwarddev/man/rk.set.language.Rd
trunk/rkward/packages/rkwarddev/man/rk.set.rkh.prompter.Rd
trunk/rkward/packages/rkwarddev/man/rkwarddev.required.Rd
trunk/rkward/packages/rkwarddev/man/tf.Rd
Modified: trunk/rkward/packages/rkwarddev/ChangeLog
===================================================================
--- trunk/rkward/packages/rkwarddev/ChangeLog 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/ChangeLog 2014-10-26 19:10:53 UTC (rev 4961)
@@ -9,7 +9,7 @@
added:
- all "help" values can now be a list of character strings or XiMpLe nodes,
to have more control over the markup
- - added "property" argument to rk.XML.valueslot() and rk.XML.varslot().
+ - added "property" and "duplicates" arguments to rk.XML.valueslot() and rk.XML.varslot().
changes in version 0.06-5 (2014-10-19)
fixed:
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.valueslot.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.valueslot.R 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.valueslot.R 2014-10-26 19:10:53 UTC (rev 4961)
@@ -27,6 +27,7 @@
#' \code{<valueselector>} node.
#' @param required Logical, whether the selection of values is mandatory or not.
#' @param multi Logical, whether the valueslot holds only one or several objects.
+#' @param duplicates Logical, if \code{multi=TRUE} defines whether the same entry may be added multiple times. Sets \code{multi=TRUE}.
#' @param min If \code{multi=TRUE} defines how many objects must be selected. Sets \code{multi=TRUE}.
#' @param any If \code{multi=TRUE} defines how many objects must be selected at least if any
#' are selected at all. Sets \code{multi=TRUE}.
@@ -53,7 +54,7 @@
#' cat(pasteXML(test.valueslot))
#' }
-rk.XML.valueslot <- function(label, source, property=NULL, required=FALSE, multi=FALSE, min=1, any=1, max=0,
+rk.XML.valueslot <- function(label, source, property=NULL, required=FALSE, multi=FALSE, duplicates=FALSE, min=1, any=1, max=0,
id.name="auto", help=NULL, component=rk.get.comp()){
if(identical(id.name, "auto")){
value.slot.attr <- list(id=auto.ids(label, prefix=ID.prefix("valueslot", length=4)))
@@ -66,12 +67,12 @@
if(is.XiMpLe.node(source)){
source.name <- slot(source, "name")
if(identical(source.name, "varselector")){
- var.slot.attr[["source"]] <- check.ID(source)
+ value.slot.attr[["source"]] <- check.ID(source)
} else {
if(is.null(property)){
stop(simpleError(paste0("'source' must either be a <varselector> node or come with an appropripate 'property' value!")))
} else if(modif.validity(source, modifier=property)){
- var.slot.attr[["source_property"]] <- paste(check.ID(source), property, sep=".")
+ value.slot.attr[["source_property"]] <- paste(check.ID(source), property, sep=".")
} else {}
}
} else {}
@@ -81,8 +82,11 @@
} else {}
# "multi" is mandatory if min, max or any are set
- if(isTRUE(multi) | min > 1 | any > 1 | max > 0){
+ if(isTRUE(multi) | isTRUE(duplicates) | min > 1 | any > 1 | max > 0){
value.slot.attr[["multi"]] <- "true"
+ if(isTRUE(duplicates)){
+ value.slot.attr[["allow_duplicates"]] <- "true"
+ } else {}
if(min > 1){
value.slot.attr[["min_vars"]] <- min
} else {}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.varslot.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.varslot.R 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.varslot.R 2014-10-26 19:10:53 UTC (rev 4961)
@@ -27,6 +27,7 @@
#' \code{<valueselector>} node.
#' @param required Logical, whether the selection of variables is mandatory or not.
#' @param multi Logical, whether the varslot holds only one or several objects.
+#' @param duplicates Logical, if \code{multi=TRUE} defines whether the same entry may be added multiple times. Sets \code{multi=TRUE}.
#' @param min If \code{multi=TRUE} defines how many objects must be selected. Sets \code{multi=TRUE}.
#' @param any If \code{multi=TRUE} defines how many objects must be selected at least if any
#' are selected at all. Sets \code{multi=TRUE}.
@@ -63,7 +64,7 @@
#' cat(pasteXML(test.varslot))
#' }
-rk.XML.varslot <- function(label, source, property=NULL, required=FALSE, multi=FALSE, min=1, any=1, max=0,
+rk.XML.varslot <- function(label, source, property=NULL, required=FALSE, multi=FALSE, duplicates=FALSE, min=1, any=1, max=0,
dim=0, min.len=0, max.len=NULL, classes=NULL, types=NULL, id.name="auto", help=NULL, component=rk.get.comp()){
if(identical(id.name, "auto")){
var.slot.attr <- list(id=auto.ids(label, prefix=ID.prefix("varslot", length=4)))
@@ -103,8 +104,11 @@
} else {}
# "multi" is mandatory if min, max or any are set
- if(isTRUE(multi) | min > 1 | any > 1 | max > 0){
+ if(isTRUE(multi) | isTRUE(duplicates) | min > 1 | any > 1 | max > 0){
var.slot.attr[["multi"]] <- "true"
+ if(isTRUE(duplicates)){
+ var.slot.attr[["allow_duplicates"]] <- "true"
+ } else {}
if(min > 1){
var.slot.attr[["min_vars"]] <- min
} else {}
Modified: trunk/rkward/packages/rkwarddev/inst/CITATION
===================================================================
--- trunk/rkward/packages/rkwarddev/inst/CITATION 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/inst/CITATION 2014-10-26 19:10:53 UTC (rev 4961)
@@ -2,12 +2,12 @@
title="rkwarddev: A collection of tools for RKWard plugin development",
author="Meik Michalke",
year="2014",
- note="(Version 0.06-5)",
+ note="(Version 0.06-6)",
url="http://rkward.sourceforge.net",
textVersion =
paste("Michalke, M. (2014). ",
- "rkwarddev: A collection of tools for RKWard plugin development (Version 0.06-5). ",
+ "rkwarddev: A collection of tools for RKWard plugin development (Version 0.06-6). ",
"Available from http://rkward.sourceforge.net",
sep=""),
Modified: trunk/rkward/packages/rkwarddev/inst/NEWS.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/inst/NEWS.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/inst/NEWS.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -1,6 +1,23 @@
\name{NEWS}
\title{News for Package 'rkwarddev'}
\encoding{UTF-8}
+\section{Changes in rkwarddev version 0.06-6 (2014-10-26)}{
+ \subsection{fixed}{
+ \itemize{
+ \item \code{rk.XML.optionset()} does now allow to re-use objects defined in the same
+ function call (i.e., refer to optioncolumns in the logic section)
+ \item removed arguments \code{"help"} and \code{"component"} from \code{rk.XML.optionscolumn()} again,
+ as these are already being documented via the objects they connect to.
+ }
+ }
+ \subsection{added}{
+ \itemize{
+ \item all \code{"help"} values can now be a list of character strings or XiMpLe nodes,
+ to have more control over the markup
+ \item added \code{"property"} and \code{"duplicates"} arguments to \code{rk.XML.valueslot()} and \code{rk.XML.varslot()}.
+ }
+ }
+}
\section{Changes in rkwarddev version 0.06-5 (2014-10-19)}{
\subsection{fixed}{
\itemize{
Modified: trunk/rkward/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf
===================================================================
(Binary files differ)
Modified: trunk/rkward/packages/rkwarddev/man/echo.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/echo.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/echo.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -7,16 +7,20 @@
}
\arguments{
\item{...}{One or several character strings and/or \code{XiMpLe.node} objects with plugin nodes,
-and/or objects of classes \code{rk.JS.arr} or \code{rk.JS.opt}, simply separated by comma.}
+and/or objects of classes \code{rk.JS.arr} or \code{rk.JS.opt},
+ simply separated by comma.}
-\item{newline}{Character string, can be set to e.g. \code{"\n"} to force a newline after the call.}
+\item{newline}{Character string,
+ can be set to e.g. \code{"\n"} to force a newline after the call.}
}
\value{
A character string.
}
\description{
-This function will take several elements, either character strings, or objects of class \code{XiMpLe.node}
-which hold an XML node of some plugin GUI definition, or objects of classes \code{rk.JS.arr} or \code{rk.JS.opt}.
+This function will take several elements, either character strings,
+ or objects of class \code{XiMpLe.node}
+which hold an XML node of some plugin GUI definition,
+ or objects of classes \code{rk.JS.arr} or \code{rk.JS.opt}.
From those, it will generate a ready-to-run JavaScript \code{echo();} call from it.
}
\examples{
Modified: trunk/rkward/packages/rkwarddev/man/i18n.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/i18n.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/i18n.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -17,7 +17,8 @@
\code{...}.
}
\details{
-If used in an \code{rkwarddev} script, this can be used to toggle the generation of plugins
+If used in an \code{rkwarddev} script,
+ this can be used to toggle the generation of plugins
in a certain language.
}
\examples{
Modified: trunk/rkward/packages/rkwarddev/man/id.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/id.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/id.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -7,14 +7,18 @@
}
\arguments{
\item{...}{One or several character strings and/or \code{XiMpLe.node} objects with plugin nodes,
-and/or objects of classes \code{rk.JS.arr}, \code{rk.JS.opt} or \code{rk.JS.var}, simply separated by comma.}
+and/or objects of classes \code{rk.JS.arr}, \code{rk.JS.opt} or \code{rk.JS.var},
+ simply separated by comma.}
-\item{quote}{Logical, it the character strings sould be deparsed, so they come out "as-is" when
+\item{quote}{Logical, it the character strings sould be deparsed,
+ so they come out "as-is" when
written to files, e.g. by \code{cat}.}
-\item{collapse}{Character string, defining if and how the individual elements should be glued together.}
+\item{collapse}{Character string,
+ defining if and how the individual elements should be glued together.}
-\item{js}{Logical, if \code{TRUE} returns JavaScript varaible names for \code{XiMpLe.node} objects.
+\item{js}{Logical,
+ if \code{TRUE} returns JavaScript varaible names for \code{XiMpLe.node} objects.
Otherwise their actual ID is returned.}
}
\value{
@@ -23,8 +27,10 @@
\description{
This function is intended to be used for generating JavaScript code for
RKWard plugins. Its sole purpose is to replace objects of class \code{XiMpLe.node}
-which hold an XML node of some plugin GUI definition, and objects of classes \code{rk.JS.arr},
-\code{rk.JS.opt} or \code{rk.JS.var} with their ID (or JS variable name), and combine these
+which hold an XML node of some plugin GUI definition,
+ and objects of classes \code{rk.JS.arr},
+\code{rk.JS.opt} or \code{rk.JS.var} with their ID (or JS variable name),
+ and combine these
replacements with character strings.
}
\examples{
Modified: trunk/rkward/packages/rkwarddev/man/ite.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/ite.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/ite.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -9,12 +9,14 @@
\item{ifjs}{Either a character string to be placed in the brackets if an \code{if()} statement,
or an object of class \code{XiMpLe.node}. \code{rk.JS.arr} or \code{rk.JS.opt} (whose identifier will be used).}
-\item{thenjs}{Either a character string, the code to be executed in case the \code{if()} statement is true,
+\item{thenjs}{Either a character string,
+ the code to be executed in case the \code{if()} statement is true,
or an object of class \code{XiMpLe.node}. \code{rk.JS.arr} or \code{rk.JS.opt} (whose identifier will be used).
The latter is especially useful in combination with \code{\link[rkwarddev:rk.JS.options]{rk.JS.options}}.
You can also give another object of class \code{rk.JS.ite}.}
-\item{elsejs}{Like \code{thenjs}, the code to be executed in case the \code{if()} statement is not true.}
+\item{elsejs}{Like \code{thenjs},
+ the code to be executed in case the \code{if()} statement is not true.}
}
\value{
An object of class \code{rk.JS.ite}
Modified: trunk/rkward/packages/rkwarddev/man/join.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/join.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/join.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -17,8 +17,10 @@
}
\description{
This function pastes an object of class \code{rk.JS.arr} similar to \code{\link[rkwarddev:rk.paste.JS]{rk.paste.JS}},
-but was specifically written for elements like \code{<optionset>} or \code{<matrix>}, whose values must be queried
-by \code{getList()} rather than \code{getValue()}. This means, the resulting variable is already an array an merely
+but was specifically written for elements like \code{<optionset>} or \code{<matrix>},
+ whose values must be queried
+by \code{getList()} rather than \code{getValue()}. This means,
+ the resulting variable is already an array an merely
needs to be joined in as R code output (e.g., an \code{<optioncolumn>}).
}
\seealso{
Modified: trunk/rkward/packages/rkwarddev/man/qp.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/qp.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/qp.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -7,7 +7,8 @@
}
\arguments{
\item{...}{One or several character strings and/or \code{XiMpLe.node} objects with plugin nodes,
-and/or objects of classes \code{rk.JS.arr} or \code{rk.JS.opt}, simply separated by comma.}
+and/or objects of classes \code{rk.JS.arr} or \code{rk.JS.opt},
+ simply separated by comma.}
}
\value{
A character string.
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.array.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.array.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.array.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -13,12 +13,14 @@
\item{variables}{A list with either character strings (the names of the variables to combine to a vector or list),
or objects of class \code{XiMpLe.node} with plugin XML nodes (whose ID will be extracted and used).}
-\item{funct}{Character string, name of the R function to be called to combine the options, e.g. "list" for \code{list()},
+\item{funct}{Character string, name of the R function to be called to combine the options,
+ e.g. "list" for \code{list()},
or "c" for \code{c()}.}
\item{var.prefix}{A character string. sets a global string to be used as a prefix for the JS variable names.}
-\item{quote}{Logical, if \code{TRUE}, the values will be quoted in the resulting R code (might be neccessary
+\item{quote}{Logical, if \code{TRUE},
+ the values will be quoted in the resulting R code (might be neccessary
for character values).}
}
\value{
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.doc.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.doc.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.doc.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -15,7 +15,8 @@
or an object of class \code{rk.JS.var} which will be coerced into character. These variables will be defined in
the \code{calculate()} and/or \code{doPrintout()} functions.}
-\item{globals}{Like \code{variables}, but these variables will be defined globally. If \code{variables} is set as well,
+\item{globals}{Like \code{variables},
+ but these variables will be defined globally. If \code{variables} is set as well,
the function tries to remove duplicate definitions.}
\item{results.header}{A character string to headline the printed results. Include escapes quotes (\\") if needed.
@@ -28,14 +29,18 @@
pasted as-is, after \code{variables} has been evaluated.}
\item{printout}{A character string to be included in the \code{printout()} function. This string will be
-pasted as-is, after \code{results.header} has been evaluated. Ignored if \code{doPrintout} is set.}
+pasted as-is,
+ after \code{results.header} has been evaluated. Ignored if \code{doPrintout} is set.}
\item{doPrintout}{A character string to be included in the \code{doPrintout()} function. This string will be
-pasted as-is. You don't need to define a \code{preview()} function, as this will be added automatically.
+pasted as-is. You don't need to define a \code{preview()} function,
+ as this will be added automatically.
Use \code{ite("full", ...)} style JavaScript code to include headers etc.}
-\item{load.silencer}{Either a character string (ID of probably a checkbox), or an object of class \code{XiMpLe.node}.
-This defines a switch you can add to your plugin, to set the \code{require()} call inside \code{suppressMessages()},
+\item{load.silencer}{Either a character string (ID of probably a checkbox),
+ or an object of class \code{XiMpLe.node}.
+This defines a switch you can add to your plugin,
+ to set the \code{require()} call inside \code{suppressMessages()},
hence suppressing all load messages (except for warnings and errors) of required packages in the output.}
\item{gen.info}{Logical, if \code{TRUE} a comment note will be written into the document,
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.options.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.options.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.options.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -10,11 +10,14 @@
\item{var}{Character string, name of the JavaScript variable to use in the script code.}
\item{...}{A list of objects of class \code{rk.JS.ite} (see \code{\link[rkwarddev:ite]{ite}}).
-Use the \code{thenjs} element to define only the value to add to the option, without commas
+Use the \code{thenjs} element to define only the value to add to the option,
+ without commas
(e.g., \code{"paired=TRUE"} or \code{qp("conf.level=\"", conflevel, "\"")}.}
-\item{collapse}{Character string, how all options should be concatenated on the R code level
-(if \code{array=FALSE}), or how \code{option} should be added to the generated R code. Hint:
+\item{collapse}{Character string,
+ how all options should be concatenated on the R code level
+(if \code{array=FALSE}),
+ or how \code{option} should be added to the generated R code. Hint:
To place each option in a new line with tab indentation, set \code{collapse=",\\n\\t"}.}
\item{option}{A character string, naming, e.g., an option of an R function which should be
@@ -24,7 +27,8 @@
e.g. "list" for \code{list()}, or "c" for \code{c()}. Set to \code{NULL} to drop.
Only used if \code{array=TRUE}.}
-\item{array}{Logical, if \code{TRUE} will generate the options as an array, otherwise in one
+\item{array}{Logical, if \code{TRUE} will generate the options as an array,
+ otherwise in one
concatenated character string (probably only useful for mandatory options).}
}
\value{
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.optionset.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.optionset.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.optionset.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -9,29 +9,36 @@
\arguments{
\item{optionset}{A XiMpLe.node object, the full \code{<optionset>} node.}
-\item{...}{The JavaScript code, optionally including the optioncolumn objects. This will become
+\item{...}{The JavaScript code,
+ optionally including the optioncolumn objects. This will become
the body of the for loop.}
\item{loopvar}{Character, name of the index variable used in the for loop.}
-\item{collapse}{Character string, how all optioncolumns should be concatenated on the R code level
-Hint: To place each one on a new line with tab indentation, set \code{collapse=",\\n\\t"}.}
+\item{collapse}{Character string,
+ how all optioncolumns should be concatenated on the R code level
+Hint: To place each one on a new line with tab indentation, set \code{collapse=",
+ \\n\\t"}.}
-\item{vars}{Logical, if \code{TRUE} all optioncolumn varaibles will be defined first. This is not
+\item{vars}{Logical,
+ if \code{TRUE} all optioncolumn varaibles will be defined first. This is not
needed if \code{\link[rkwarddev:rk.JS.scan]{rk.JS.scan}} was already called.}
-\item{guess.getter}{Logical, if \code{TRUE} try to get a good default getter function for JavaScript
+\item{guess.getter}{Logical,
+ if \code{TRUE} try to get a good default getter function for JavaScript
variable values. Only relevant if \code{vars=TRUE}.}
}
\description{
This function scans an object generated by \code{\link[rkwarddev:rk.XML.optionset]{rk.XML.optionset}},
extract IDs of all optioncolumn objects and nest the JavaScript code you define via \code{...} inside
-a for loop that iterates through all columns. Inside \code{...}, you can use the column objects of
+a for loop that iterates through all columns. Inside \code{...},
+ you can use the column objects of
\code{\link[rkwarddev:rk.XML.optioncolumn]{rk.XML.optioncolumn}} to refer to the respective column,
\code{rk.JS.optionset} will use appropriate variables.
}
\details{
-In case you simply want to define the variables, but not run the loop yet, set \code{vars=TRUE} and
+In case you simply want to define the variables, but not run the loop yet,
+ set \code{vars=TRUE} and
leave \code{...} empty.
}
\examples{
@@ -47,7 +54,8 @@
)
)), label="Depends on R packages"),
optioncolumn=list(
- dep.optioncol.pckg.name <- rk.XML.optioncolumn(connect=dep.pckg.name, modifier="text"),
+ dep.optioncol.pckg.name <- rk.XML.optioncolumn(connect=dep.pckg.name,
+ modifier="text"),
dep.optioncol.pckg.min <- rk.XML.optioncolumn(connect=dep.pckg.min, modifier="text"),
dep.optioncol.pckg.max <- rk.XML.optioncolumn(connect=dep.pckg.max, modifier="text"),
dep.optioncol.pckg.repo <- rk.XML.optioncolumn(connect=dep.pckg.repo, modifier="text")
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.saveobj.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.saveobj.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.saveobj.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -7,15 +7,20 @@
add.abbrev = FALSE, indent.by = "\\t")
}
\arguments{
-\item{pXML}{Either an object of class \code{XiMpLe.doc} or \code{XiMpLe.node}, or path to a plugin XML file.}
+\item{pXML}{Either an object of class \code{XiMpLe.doc} or \code{XiMpLe.node},
+ or path to a plugin XML file.}
-\item{R.objects}{Character vector, the names of the internal R objects to be saved. If not empty must have
-the same length as <saveobject> nodes in the document, or be the keyword "initial", in which case the
+\item{R.objects}{Character vector,
+ the names of the internal R objects to be saved. If not empty must have
+the same length as <saveobject> nodes in the document, or be the keyword "initial",
+ in which case the
\code{intital} attribute values of the nodes are used.}
-\item{vars}{Logocal, whether the variables needed should also be defined in the JavaScript code.}
+\item{vars}{Logocal,
+ whether the variables needed should also be defined in the JavaScript code.}
-\item{add.abbrev}{Logical, if \code{TRUE} the JavaScript variables will all have a prefix with an
+\item{add.abbrev}{Logical,
+ if \code{TRUE} the JavaScript variables will all have a prefix with an
three letter abbreviation of the XML tag type to improve the readability of the code. But it's
probably better to add this in the XML code in the first place.}
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.scan.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.scan.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.scan.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -7,18 +7,24 @@
indent.by = "\\t")
}
\arguments{
-\item{pXML}{Either an object of class \code{XiMpLe.doc} or \code{XiMpLe.node}, or path to a plugin XML file.}
+\item{pXML}{Either an object of class \code{XiMpLe.doc} or \code{XiMpLe.node},
+ or path to a plugin XML file.}
-\item{js}{Logical, if \code{TRUE} usable JavaScript code will be returned, otherwise a character
+\item{js}{Logical, if \code{TRUE} usable JavaScript code will be returned,
+ otherwise a character
vector with only the relevant ID names.}
-\item{add.abbrev}{Logical, if \code{TRUE} the JavaScript variables will all have a prefix with an
+\item{add.abbrev}{Logical,
+ if \code{TRUE} the JavaScript variables will all have a prefix with an
three letter abbreviation of the XML tag type to improve the readability of the code. But it's
probably better to add this in the XML code in the first place.}
-\item{guess.getter}{Logical, if \code{TRUE} try to get a good default getter function for JavaScript
-variable values. This will use some functions which were added with RKWard 0.6.1, and therefore
-raise the dependencies for your plugin/component accordingly. Nonetheless, it's recommended.}
+\item{guess.getter}{Logical,
+ if \code{TRUE} try to get a good default getter function for JavaScript
+variable values. This will use some functions which were added with RKWard 0.6.1,
+ and therefore
+raise the dependencies for your plugin/component accordingly. Nonetheless,
+ it's recommended.}
\item{indent.by}{Character string used to indent each entry if \code{js=TRUE}.}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.vars.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.vars.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.vars.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -15,21 +15,29 @@
\item{modifiers}{A character vector with modifiers you'd like to apply to the XML node property.}
-\item{default}{Logical, if \code{TRUE} the default value (no special modifier) of the node will
+\item{default}{Logical,
+ if \code{TRUE} the default value (no special modifier) of the node will
also be defined. Does nothing if \code{modifiers=NULL}.}
-\item{join}{A character string, useful for GUI elements which accept multiple objects (e.g., multi-varslots).
-If \code{join} is something other than \code{""}, these objects will be collapsed into one string when pasted,
+\item{join}{A character string,
+ useful for GUI elements which accept multiple objects (e.g., multi-varslots).
+If \code{join} is something other than \code{""},
+ these objects will be collapsed into one string when pasted,
joined by this string.}
-\item{check.modifiers}{Logical, if \code{TRUE} the given modifiers will be checked for validity. Should only be
+\item{check.modifiers}{Logical,
+ if \code{TRUE} the given modifiers will be checked for validity. Should only be
turned off if you know what you're doing.}
-\item{getter}{A character string, naming the JavaScript function which should be used to get the values in the
-actual plugin. Depending on the XML element, \code{"getString"}, \code{"getBool"} or \code{"getList"} can be
-useful alternatives. For backwards compatibility, the default is set to \code{"getValue"}.}
+\item{getter}{A character string,
+ naming the JavaScript function which should be used to get the values in the
+actual plugin. Depending on the XML element, \code{"getString"},
+ \code{"getBool"} or \code{"getList"} can be
+useful alternatives. For backwards compatibility,
+ the default is set to \code{"getValue"}.}
-\item{guess.getter}{Logical, if \code{TRUE} try to get a good default getter function for JavaScript
+\item{guess.getter}{Logical,
+ if \code{TRUE} try to get a good default getter function for JavaScript
variable values.}
}
\value{
@@ -39,7 +47,8 @@
Define variables in JavaScript code
}
\note{
-To get a list of the implemented modifiers in this package, call \code{rkwarddev:::all.valid.modifiers}.
+To get a list of the implemented modifiers in this package,
+ call \code{rkwarddev:::all.valid.modifiers}.
}
\examples{
# create three checkboxes
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.about.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.about.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.about.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -16,9 +16,11 @@
\item{given}{Author given name}
\item{family}{Author family name}
\item{email}{Author mail address (can be omitted if \code{role} does not include \code{"cre"})}
- \item{role}{This person's specific role, e.g. \code{"aut"} for actual author, \code{"cre"} for maintainer or \code{"ctb"} for contributor.}
+ \item{role}{This person's specific role, e.g. \code{"aut"} for actual author,
+ \code{"cre"} for maintainer or \code{"ctb"} for contributor.}
}
-See \code{\link[utils:person]{person}} for more details on this, especially for valid roles.}
+See \code{\link[utils:person]{person}} for more details on this,
+ especially for valid roles.}
\item{about}{A named list with these elements:
\describe{
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -10,25 +10,32 @@
\arguments{
\item{label}{Character string, a text label for this plugin element.}
-\item{type}{Character string, valid values are "dir", "file" and "savefile" (i.e., an non-existing file).}
+\item{type}{Character string, valid values are "dir", "file" and "savefile" (i.e.,
+ an non-existing file).}
-\item{initial}{Character string, if not \code{NULL} will be used as the initial value of the browser.}
+\item{initial}{Character string,
+ if not \code{NULL} will be used as the initial value of the browser.}
\item{urls}{Logical, whether non-local URLs are permitted or not.}
-\item{filter}{Character vector, file type filter, e.g. \code{filter=c("*.txt", "*.csv")} for .txt and .csv files.
+\item{filter}{Character vector, file type filter, e.g. \code{filter=c("*.txt",
+ "*.csv")} for .txt and .csv files.
Try not to induce limits unless absolutely needed, though.}
\item{required}{Logical, whether an entry is mandatory or not.}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.}
+If \code{"auto"} and a label was provided,
+ an ID will be generated automatically from the label.}
-\item{help}{Character string or list of character values and XiMpLe nodes, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string or list of character values and XiMpLe nodes,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -19,11 +19,14 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the label.}
-\item{help}{Character string or list of character values and XiMpLe nodes, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string or list of character values and XiMpLe nodes,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -14,7 +14,8 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the label.}
-\item{type}{Character string, type of component. As of now, only "standard" is supported. The option is
+\item{type}{Character string, type of component. As of now,
+ only "standard" is supported. The option is
just implemented for completeness.}
\item{dependencies}{An object of class \code{XiMpLe.node} to define \code{<dependencies>} for this component.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.components.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.components.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.components.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -12,7 +12,8 @@
A list of objects of class \code{XiMpLe.node}.
}
\description{
-This function will create a components node for a .pluginmap file, with mandatory child nodes "component".
+This function will create a components node for a .pluginmap file,
+ with mandatory child nodes "component".
}
\examples{
test.component <- rk.XML.component("My GUI dialog", "plugins/MyGUIdialog.xml")
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -8,21 +8,27 @@
}
\arguments{
\item{governor}{Either a character string (the \code{id} of the property whose state should control
-the \code{client}), or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted
+the \code{client}),
+ or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted
and used). Usually a \code{<convert>} node defined earlier (see
\code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}}).}
-\item{client}{Character string, the \code{id} if the element to be controlled by \code{governor}.}
+\item{client}{Character string,
+ the \code{id} if the element to be controlled by \code{governor}.}
-\item{get}{Character string, a valid modifier for the node property of \code{governor}, often
+\item{get}{Character string, a valid modifier for the node property of \code{governor},
+ often
the ".state" value of some apropriate node.}
-\item{set}{Character string, a valid modifier for the node property of \code{client}, usually
+\item{set}{Character string, a valid modifier for the node property of \code{client},
+ usually
one of \code{"enabled"}, \code{"visible"} or \code{"required"}.}
-\item{not}{Logical, if \code{TRUE}, the state of \code{governor} (\code{TRUE/FALSE}) will be inversed.}
+\item{not}{Logical, if \code{TRUE},
+ the state of \code{governor} (\code{TRUE/FALSE}) will be inversed.}
-\item{reconcile}{Logical, forces the \code{governor} to only accept values which are valid for
+\item{reconcile}{Logical,
+ forces the \code{governor} to only accept values which are valid for
the \code{client} as well.}
}
\value{
@@ -33,7 +39,8 @@
and \code{not=FALSE}, the function will automatically append to its \code{id}.
}
\note{
-To get a list of the implemented modifiers in this package, call \code{rkwarddev:::all.valid.modifiers}.
+To get a list of the implemented modifiers in this package,
+ call \code{rkwarddev:::all.valid.modifiers}.
}
\examples{
test.connect <- rk.XML.connect(governor="lgc_foobar", client="frame_bar")
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -9,7 +9,8 @@
\item{sources}{A list with at least one value, either resembling the \code{id} of
an existing element to be queried as a character string, or a previously defined object
of class \code{XiMpLe.node} (whose \code{id} will be extracted and used). If you want
-to examine e.g. the state or string value specificly, just name the value accoringly, e.g.,
+to examine e.g. the state or string value specificly, just name the value accoringly,
+ e.g.,
\code{sources=list("vars0", string="input1", state="chkbx2")}.}
\item{mode}{A named vector with either exactly one of the following elements:
@@ -27,7 +28,8 @@
\item{\code{max}}{True if \code{sources} is below this value. They must be numeric.}
}}
-\item{required}{Logical, sets the state of the \code{required_true} attribute. If \code{TRUE},
+\item{required}{Logical,
+ sets the state of the \code{required_true} attribute. If \code{TRUE},
the plugin submit button is only enabled if this property is true.}
\item{id.name}{Character string, a unique ID for this plugin element.
@@ -38,10 +40,12 @@
An object of class \code{XiMpLe.node}.
}
\description{
-If \code{sources} holds \code{XiMpLe.node} objects, the validity of modifiers is automatically checked for that tag.
+If \code{sources} holds \code{XiMpLe.node} objects,
+ the validity of modifiers is automatically checked for that tag.
}
\note{
-To get a list of the implemented modifiers for \code{sources} in this package, call \code{rkwarddev:::all.valid.modifiers}.
+To get a list of the implemented modifiers for \code{sources} in this package,
+ call \code{rkwarddev:::all.valid.modifiers}.
}
\examples{
test.convert <- rk.XML.convert(list(string="foo"), mode=c(notequals="bar"))
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -9,7 +9,8 @@
\item{id}{Either a character string (the \code{id} of the property to be copied),
or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used).}
-\item{as}{A character string resembling the \code{copy_element_tag_name} value. I.e., must be
+\item{as}{A character string resembling the \code{copy_element_tag_name} value. I.e.,
+ must be
a valid tag name. Will cause a change of tag name of the \code{id} (e.g. "tab") to \code{as}
(e.g. "page").}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.dependencies.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.dependencies.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.dependencies.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -29,13 +29,15 @@
\item{url}{URL to get the pluginmap (optional)}
}}
-\item{hints}{Logical, if \code{TRUE}, \code{NULL} values will be replaced with example text.}
+\item{hints}{Logical, if \code{TRUE},
+ \code{NULL} values will be replaced with example text.}
}
\description{
Create XML node "dependencies" for RKWard pluginmaps
}
\note{
-The \code{<dependencies>} node was introduced with RKWard 0.6.1, please set the dependencies
+The \code{<dependencies>} node was introduced with RKWard 0.6.1,
+ please set the dependencies
of your component/plugin accordingly.
}
\examples{
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.dependency_check.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.dependency_check.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.dependency_check.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -31,13 +31,15 @@
\item{url}{URL to get the pluginmap (optional)}
}}
-\item{hints}{Logical, if \code{TRUE}, \code{NULL} values will be replaced with example text.}
+\item{hints}{Logical, if \code{TRUE},
+ \code{NULL} values will be replaced with example text.}
}
\description{
Create XML node "dependency_check" for RKWard pluginmaps
}
\note{
-The \code{<dependency_check>} node was introduced with RKWard 0.6.1, please set the dependencies
+The \code{<dependency_check>} node was introduced with RKWard 0.6.1,
+ please set the dependencies
of your component/plugin accordingly.
}
\examples{
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -10,17 +10,21 @@
\item{label}{Character string, a text label for this plugin element.}
-\item{recommended}{Logical, whether the dialog should be the recommended interface (unless the user has configured
-RKWard to default to a specific interface). This attribute currently has no effect, as it is implicitly "true",
+\item{recommended}{Logical,
+ whether the dialog should be the recommended interface (unless the user has configured
+RKWard to default to a specific interface). This attribute currently has no effect,
+ as it is implicitly "true",
unless the wizard is recommended.}
}
\value{
An object of class \code{XiMpLe.node}.
}
\description{
-This function will create a dialog section with optional child nodes "browser", "checkbox",
+This function will create a dialog section with optional child nodes "browser",
+ "checkbox",
"column", "copy", "dropdown", "embed", "formula", "frame", "include", "input", "insert",
-"preview", "radio", "row", "saveobject", "select", "spinbox", "stretch", "tabbook", "text",
+"preview", "radio", "row", "saveobject", "select", "spinbox", "stretch", "tabbook",
+ "text",
"valueselector", "valueslot", "varselector" and "varslot".
}
\examples{
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -10,18 +10,23 @@
\item{label}{Character string, a text label for this plugin element.}
\item{options}{A named list with options to choose from. The names of the list elements will become
-labels of the options, \code{val} defines the value to submit if the option is checked, and
+labels of the options, \code{val} defines the value to submit if the option is checked,
+ and
\code{chk=TRUE} should be set in the one option which is checked by default. Objects generated with
\code{\link[rkwarddev:rk.XML.option]{rk.XML.option}} are accepted as well.}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.}
+If \code{"auto"} and a label was provided,
+ an ID will be generated automatically from the label.}
-\item{help}{Character string or list of character values and XiMpLe nodes, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string or list of character values and XiMpLe nodes,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -7,14 +7,18 @@
id.name = "auto")
}
\arguments{
-\item{component}{A character string, registered name (\code{id} in pluginmap file) of the component to be embedded.}
+\item{component}{A character string,
+ registered name (\code{id} in pluginmap file) of the component to be embedded.}
-\item{button}{Logical, whether the plugin should be embedded as a button and appear if it's pressed.}
+\item{button}{Logical,
+ whether the plugin should be embedded as a button and appear if it's pressed.}
-\item{label}{A character string, text label for the button (only used if \code{button=TRUE}).}
+\item{label}{A character string,
+ text label for the button (only used if \code{button=TRUE}).}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"}, an ID will be generated automatically from the label and component strings.}
+If \code{"auto"},
+ an ID will be generated automatically from the label and component strings.}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.formula.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.formula.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.formula.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -11,7 +11,8 @@
\item{dependent}{The \code{id} of the varslot holding the selected dependent variable.}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"}, an ID will be generated automatically from the \code{fixed} and \code{dependent} value.}
+If \code{"auto"},
+ an ID will be generated automatically from the \code{fixed} and \code{dependent} value.}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.frame.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.frame.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.frame.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -13,10 +13,12 @@
\item{checkable}{Logical, if \code{TRUE} the frame can be switched on and off.}
-\item{chk}{Logical, if \code{TRUE} and \code{checkable=TRUE} the frame is checkable and active by default.}
+\item{chk}{Logical,
+ if \code{TRUE} and \code{checkable=TRUE} the frame is checkable and active by default.}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"} and a label was provided, an ID will be generated automatically from the label
+If \code{"auto"} and a label was provided,
+ an ID will be generated automatically from the label
if presen, otherwise from the objects in the frame.
If \code{NULL}, no ID will be given.}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -9,7 +9,8 @@
\arguments{
\item{label}{Character string, a text label for this plugin element.}
-\item{initial}{Character string, if not \code{NULL} will be used as the initial value of the input field.}
+\item{initial}{Character string,
+ if not \code{NULL} will be used as the initial value of the input field.}
\item{size}{One value of either "small", "medium" or "large".}
@@ -18,11 +19,14 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the label.}
-\item{help}{Character string or list of character values and XiMpLe nodes, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string or list of character values and XiMpLe nodes,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -12,8 +12,10 @@
An object of class \code{XiMpLe.node}.
}
\description{
-This function will create a logic section with "convert", "connect", "include", "insert", "external" and "set" nodes.
-You can also include JavaScript code to use the locig scripting features of RKWard, if you place it in a comment
+This function will create a logic section with "convert", "connect", "include", "insert",
+ "external" and "set" nodes.
+You can also include JavaScript code to use the locig scripting features of RKWard,
+ if you place it in a comment
with \code{\link[rkwarddev:rk.comment]{rk.comment}}: Its contents will automatically be placed inside a
\code{<script><![CDATA[ ]]></script>} node.
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.matrix.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.matrix.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.matrix.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -12,7 +12,8 @@
\arguments{
\item{label}{Character string, a label for the matrix.}
-\item{mode}{Character string, one of "integer", "real" or "string". The type of data that will
+\item{mode}{Character string, one of "integer",
+ "real" or "string". The type of data that will
be accepted in the table (required)}
\item{rows}{Number of rows in the matrix. Has no effect if \code{allow_user_resize_rows=TRUE}.}
@@ -28,17 +29,21 @@
\item{allow_missings}{Logical, whether missing (empty) values are allowed in the matrix
(if \code{type} is "string").}
-\item{allow_user_resize_columns}{Logical, if \code{TRUE}, the user can add columns by typing
+\item{allow_user_resize_columns}{Logical, if \code{TRUE},
+ the user can add columns by typing
on the rightmost (inactive) cells.}
-\item{allow_user_resize_rows}{Logical, if \code{TRUE}, the user can add rows by typing on the
+\item{allow_user_resize_rows}{Logical, if \code{TRUE},
+ the user can add rows by typing on the
bottommost (inactive) cells.}
-\item{fixed_width}{Logical, force the GUI element to stay at its initial width. Do not use in
+\item{fixed_width}{Logical,
+ force the GUI element to stay at its initial width. Do not use in
combindation with matrices, where the number of columns may change in any way.
Useful, esp. when creating a vector input element (rows="1").}
-\item{fixed_height}{Logical, force the GUI element to stay at its initial height. Do not use in
+\item{fixed_height}{Logical,
+ force the GUI element to stay at its initial height. Do not use in
combindation with matrices, where the number of rows may change in any way.
Useful, esp. when creating a vector input element (columns="1").}
@@ -49,11 +54,14 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the label.}
-\item{help}{Character string or list of character values and XiMpLe nodes, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string or list of character values and XiMpLe nodes,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -13,11 +13,13 @@
with the last element being the \code{component} value for \code{\link[rkwarddev:rk.XML.entry]{rk.XML.entry}}.}
\item{index}{Integer number to influence the level of menu placement. If \code{...} is a list,
-\code{index} can also be a vector of the same length + 1, so indices will be set in the same order to the
+\code{index} can also be a vector of the same length + 1,
+ so indices will be set in the same order to the
menu levels, the last value is for the entry.}
\item{id.name}{Character, a unique ID for this plugin element.
-If \code{"auto"}, an ID will be generated automatically from the label. Otherwise, if \code{...} is a list,
+If \code{"auto"}, an ID will be generated automatically from the label. Otherwise,
+ if \code{...} is a list,
\code{id.name} must have the same length and will be set in the same order to the menu levels.
Used to place the menu in the global menu hierarchy.}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.option.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.option.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.option.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -10,10 +10,12 @@
\item{val}{Character string, defines the value to submit if the option is checked.}
-\item{chk}{Logical, should be set \code{TRUE} in the one option which is checked by default.}
+\item{chk}{Logical,
+ should be set \code{TRUE} in the one option which is checked by default.}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.}
+If \code{"auto"} and a label was provided,
+ an ID will be generated automatically from the label.}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.optioncolumn.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.optioncolumn.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.optioncolumn.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -7,19 +7,27 @@
external = FALSE, default = NULL, id.name = "auto")
}
\arguments{
-\item{connect}{Either a character string (the \code{id} of the property to connect this optioncolumn to), or an object of
-class XiMpLe.node (whose \code{id} will be extracted and used). For external \code{<optioncolumn>}s, the corresponding value will
-be set to the externally set value. For regular (non-external) \code{<optioncolumn>}s, the corresponding row of the \code{<optioncolumn>} property, will be set
+\item{connect}{Either a character string (the \code{id} of the property to connect this optioncolumn to),
+ or an object of
+class XiMpLe.node (whose \code{id} will be extracted and used). For external \code{<optioncolumn>}s,
+ the corresponding value will
+be set to the externally set value. For regular (non-external) \code{<optioncolumn>}s,
+ the corresponding row of the \code{<optioncolumn>} property, will be set
when the property changes inside the content-area.}
-\item{modifier}{Character string, the modifier of the property to connect to, will be appended to the \code{id} of \code{connect}.}
+\item{modifier}{Character string, the modifier of the property to connect to,
+ will be appended to the \code{id} of \code{connect}.}
-\item{label}{Either logical or a character string. If given, the optioncolumn will be displayed in the \code{<optiondisplay>} in a column by that label.
-If set to \code{TRUE} and you provide a XiMpLe node object to \code{connect}, the label will be extracted from that node.}
+\item{label}{Either logical or a character string. If given,
+ the optioncolumn will be displayed in the \code{<optiondisplay>} in a column by that label.
+If set to \code{TRUE} and you provide a XiMpLe node object to \code{connect},
+ the label will be extracted from that node.}
-\item{external}{Logical, set to \code{TRUE} if the optioncolumn is controlled from outside the optionset.}
+\item{external}{Logical,
+ set to \code{TRUE} if the optioncolumn is controlled from outside the optionset.}
-\item{default}{Character string, only for external columns: The value to assume for this column, if no value is known for an entry. Rarely useful.}
+\item{default}{Character string,
+ only for external columns: The value to assume for this column, if no value is known for an entry. Rarely useful.}
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the \code{connect} object.}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.optionset.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.optionset.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.optionset.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -12,22 +12,28 @@
\item{optioncolumn}{A list of \code{<optioncolumn>} XiMpLe.nodes.}
-\item{min_rows}{Numeric (integer), if specified, the set will be marked invalid, unless it has
+\item{min_rows}{Numeric (integer), if specified, the set will be marked invalid,
+ unless it has
at least this number of rows. Ignored if set to 0.}
-\item{min_rows_if_any}{Numeric (integer), like min_rows, but will only be tested, if there is at
+\item{min_rows_if_any}{Numeric (integer), like min_rows, but will only be tested,
+ if there is at
least one row. Ignored if set to 0.}
-\item{max_rows}{Numeric (integer), if specified, the set will be marked invalid, unless it has
+\item{max_rows}{Numeric (integer), if specified, the set will be marked invalid,
+ unless it has
at most this number of rows. Ignored if set to 0.}
\item{keycolumn}{Character}
\item{logic}{A valid \code{<logic>} node.}
-\item{optiondisplay}{Logical value, can be used to automatically add an \code{<optiondisplay>} node on top
-of the \code{<content>} section. Depending on whether it's \code{TRUE} or \code{FALSE}, its \code{index}
-argument will be set to \code{"true"} or \code{"false"}, respectively. Set to \code{NULL} to deactivate.}
+\item{optiondisplay}{Logical value,
+ can be used to automatically add an \code{<optiondisplay>} node on top
+of the \code{<content>} section. Depending on whether it's \code{TRUE} or \code{FALSE},
+ its \code{index}
+argument will be set to \code{"true"} or \code{"false"},
+ respectively. Set to \code{NULL} to deactivate.}
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the <content> nodes.}
@@ -39,13 +45,16 @@
Note that if you want to refer to the optioncolumns in your JavaScript code, the \code{id}
you need is a combination of \code{<optionset id>.<optioncolumn id>.<modifier>}. that is,
you must always prefix it with the sets' \code{id}. For JavaScript code generating with
-\code{rkwarddev}, the easiest way to get to results is to use \code{\link[rkwarddev:rk.JS.optionset]{rk.JS.optionset}}.
+\code{rkwarddev},
+ the easiest way to get to results is to use \code{\link[rkwarddev:rk.JS.optionset]{rk.JS.optionset}}.
It will automatically place your code fragments into a for loop and iterate through all available
rows of the set.
}
\details{
-If this isn't flexible enough for your needs, you can also use the ID that functions like \code{\link[rkwarddev:id]{id}}
-return, because the JavaScript variable name will only contain a constant prefix ("ocol") and the column ID.
+If this isn't flexible enough for your needs,
+ you can also use the ID that functions like \code{\link[rkwarddev:id]{id}}
+return,
+ because the JavaScript variable name will only contain a constant prefix ("ocol") and the column ID.
}
\note{
The \code{<optionset>} node was introduced with RKWard 0.6.1, please set the dependencies
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -16,9 +16,12 @@
An object of class \code{XiMpLe.node}.
}
\description{
-This function will create a page node for wizard sections, with optional child nodes "browser", "checkbox",
-"column", "copy", "dropdown", "formula", "frame", "input", "page", "radio", "row", "saveobject",
-"select", "spinbox", "stretch", "tabbook", "text", "valueselector", "valueslot", "varselector" and "varslot".
+This function will create a page node for wizard sections,
+ with optional child nodes "browser", "checkbox",
+"column", "copy", "dropdown", "formula", "frame", "input", "page", "radio", "row",
+ "saveobject",
+"select", "spinbox", "stretch", "tabbook", "text", "valueselector", "valueslot",
+ "varselector" and "varslot".
}
\examples{
# define a checkbox for the actual dialog
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -9,7 +9,8 @@
gen.info = TRUE, lang = rk.get.language())
}
\arguments{
-\item{name}{Character string, the name of the plugin. Will be used for the names of the JavaScript and
+\item{name}{Character string,
+ the name of the plugin. Will be used for the names of the JavaScript and
help files to be included, following the scheme \emph{"<name>.<ext>"}.}
\item{dialog}{An object of class \code{XiMpLe.node} to be pasted as the \code{<dialog>} section. See
@@ -24,18 +25,24 @@
\item{snippets}{An object of class \code{XiMpLe.node} to be pasted as the \code{<snippets>} section. See
\code{\link[rkwarddev:rk.XML.snippets]{rk.XML.snippets}} for details.}
-\item{provides}{Character vector with possible entries of \code{"logic"}, \code{"dialog"} or \code{"wizard"}, defining what
-sections the document should provide even if \code{dialog}, \code{wizard} and \code{logic} are \code{NULL}.
+\item{provides}{Character vector with possible entries of \code{"logic"},
+ \code{"dialog"} or \code{"wizard"}, defining what
+sections the document should provide even if \code{dialog},
+ \code{wizard} and \code{logic} are \code{NULL}.
These sections must be edited manually and some parts are therefore commented out.}
-\item{help}{Logical, if \code{TRUE} an include tag for a help file named \emph{"<name>.rkh"} will be added to the header.}
+\item{help}{Logical,
+ if \code{TRUE} an include tag for a help file named \emph{"<name>.rkh"} will be added to the header.}
-\item{include}{Character string or vector, relative path(s) to other file(s), which will then be included in the head of the GUI XML document.}
+\item{include}{Character string or vector, relative path(s) to other file(s),
+ which will then be included in the head of the GUI XML document.}
-\item{label}{Character string, a text label for the plugin's top level, i.e. the window title of the dialog.
+\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}.}
-\item{clean.name}{Logical, if \code{TRUE}, all non-alphanumeric characters except the underscore (\code{"_"}) will be removed from \code{name}.}
+\item{clean.name}{Logical, if \code{TRUE},
+ all non-alphanumeric characters except the underscore (\code{"_"}) will be removed from \code{name}.}
\item{about}{An object of class \code{XiMpLe.node} with descriptive information on the plugin and its authors,
see \code{link[XiMpLe:rk.XML.about]{rk.XML.about}} for details. Only useful for information that differs from the \code{<about>}
@@ -47,7 +54,8 @@
\item{gen.info}{Logical, if \code{TRUE} a comment note will be written into the document,
that it was generated by \code{rkwarddev} and changes should be done to the script.}
-\item{lang}{Character string, the language of the plugin. See \code{\link[rkwarddev:i18n]{i18n}} for details.}
+\item{lang}{Character string,
+ the language of the plugin. See \code{\link[rkwarddev:i18n]{i18n}} for details.}
}
\value{
An object of class \code{XiMpLe.doc}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.pluginmap.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.pluginmap.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.pluginmap.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -17,30 +17,39 @@
\item{components}{Either an object of class \code{XiMpLe.node} to be pasted as the \code{<components>} section (see
\code{\link[rkwarddev:rk.XML.components]{rk.XML.components}} for details). Or a character vector with at least
-one plugin component file name, relative path from the pluginmap file and ending with ".xml". Can be set to \code{NULL} if
+one plugin component file name,
+ relative path from the pluginmap file and ending with ".xml". Can be set to \code{NULL} if
\code{require} is used accordingly.}
\item{hierarchy}{Either an object of class \code{XiMpLe.node} to be pasted as the \code{<hierarchy>} section (see
\code{\link[rkwarddev:rk.XML.hierarchy]{rk.XML.hierarchy}} for details). Or a character vector with instructions
-where to place the plugin in the menu hierarchy, one list or string for each included component. Valid single values are
-\code{"file"}, \code{"edit"}, \code{"view"}, \code{"workspace"}, \code{"run"}, \code{"data"},
-\code{"analysis"}, \code{"plots"}, \code{"distributions"}, \code{"windows"}, \code{"settings"} and \code{"help"},
-anything else will place it in a "test" menu. If \code{hierarchy} is a list, each entry represents the label of a menu level.
+where to place the plugin in the menu hierarchy,
+ one list or string for each included component. Valid single values are
+\code{"file"}, \code{"edit"}, \code{"view"}, \code{"workspace"}, \code{"run"},
+ \code{"data"},
+\code{"analysis"}, \code{"plots"}, \code{"distributions"}, \code{"windows"},
+ \code{"settings"} and \code{"help"},
+anything else will place it in a "test" menu. If \code{hierarchy} is a list,
+ each entry represents the label of a menu level.
Can be set to \code{NULL} if \code{require} is used accordingly.}
\item{require}{Either a (list of) objects of class \code{XiMpLe.node} to be pasted as a \code{<require>} section (see
\code{\link[rkwarddev:rk.XML.require]{rk.XML.require}} for details). Or a character vector with at least
one .pluginmap filename to be included in this one.}
-\item{x11.context}{An object of class \code{XiMpLe.node} to be pasted as a \code{<context id="x11">} section, see
+\item{x11.context}{An object of class \code{XiMpLe.node} to be pasted as a \code{<context id="x11">} section,
+ see
\code{\link[rkwarddev:rk.XML.context]{rk.XML.context}} for details.}
-\item{import.context}{An object of class \code{XiMpLe.node} to be pasted as the \code{<context id="import">} section, see
+\item{import.context}{An object of class \code{XiMpLe.node} to be pasted as the \code{<context id="import">} section,
+ see
\code{\link[rkwarddev:rk.XML.context]{rk.XML.context}} for details.}
-\item{clean.name}{Logical, if \code{TRUE}, all non-alphanumeric characters except the underscore (\code{"_"}) will be removed from \code{name}.}
+\item{clean.name}{Logical, if \code{TRUE},
+ all non-alphanumeric characters except the underscore (\code{"_"}) will be removed from \code{name}.}
-\item{hints}{Logical, if \code{TRUE} and you leave out optional entries (like \code{about=NULL}), dummy sections will be added as comments.}
+\item{hints}{Logical,
+ if \code{TRUE} and you leave out optional entries (like \code{about=NULL}), dummy sections will be added as comments.}
\item{gen.info}{Logical, if \code{TRUE} a comment note will be written into the document,
that it was generated by \code{rkwarddev} and changes should be done to the script.}
@@ -48,12 +57,15 @@
\item{dependencies}{An object of class \code{XiMpLe.node} to be pasted as the \code{<dependencies>} section,
See \code{\link[rkwarddev:rk.XML.dependencies]{rk.XML.dependencies}} for details. Skipped if \code{NULL}.}
-\item{namespace}{Character string, the namespace attribute of the \code{<document>} node, defaults to the plugin name (which you probably shouldn't touch...)}
+\item{namespace}{Character string, the namespace attribute of the \code{<document>} node,
+ defaults to the plugin name (which you probably shouldn't touch...)}
-\item{priority}{Character string, the priority attribute of the \code{<document>} node. Must be either "hidden", "low", "medium", or "high",
+\item{priority}{Character string,
+ the priority attribute of the \code{<document>} node. Must be either "hidden", "low", "medium", or "high",
defaults to "medium".}
-\item{lang}{Character string, the language of the document. See \code{\link[rkwarddev:i18n]{i18n}} for details.}
+\item{lang}{Character string,
+ the language of the document. See \code{\link[rkwarddev:i18n]{i18n}} for details.}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.radio.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.radio.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.radio.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -10,17 +10,21 @@
\item{label}{Character string, a text label for this plugin element.}
\item{options}{A named list with options to choose from. The names of the list elements will become
-labels of the options, \code{val} defines the value to submit if the option is checked, and
+labels of the options, \code{val} defines the value to submit if the option is checked,
+ and
\code{chk=TRUE} should be set in the one option which is checked by default. Objects generated with
\code{\link[rkwarddev:rk.XML.option]{rk.XML.option}} are accepted as well.}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.}
+If \code{"auto"} and a label was provided,
+ an ID will be generated automatically from the label.}
-\item{help}{Character string or list of character values and XiMpLe nodes, will be used as the \code{text} value for a setting node in the .rkh file.
+\item{help}{Character string or list of character values and XiMpLe nodes,
+ will be used as the \code{text} value for a setting node in the .rkh file.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.require.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.require.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.require.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -6,13 +6,16 @@
rk.XML.require(file = NULL, map = NULL, localized = FALSE)
}
\arguments{
-\item{file}{Character string, file name of another .pluginmap file to be included. Should be
+\item{file}{Character string,
+ file name of another .pluginmap file to be included. Should be
preferred over \code{map} if that file is in the same package.}
-\item{map}{Character string, should be \code{"namespace::id"} of another .pluginmap to be included.
+\item{map}{Character string,
+ should be \code{"namespace::id"} of another .pluginmap to be included.
Can be used to address plugin maps which are not part of the same plugin package.}
-\item{localized}{Logical, only useful for plugins with static internationalisation. Adds the \code{localized}
+\item{localized}{Logical,
+ only useful for plugins with static internationalisation. Adds the \code{localized}
attribute if set to \code{TRUE}; \code{file} must then point to the default pluginmap in a subdirectory
containing all localised pluginmaps.}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.saveobj.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.saveobj.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.saveobj.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -10,23 +10,29 @@
\arguments{
\item{label}{Character string, a text label for this plugin element.}
-\item{chk}{Logical, if \code{TRUE} and \code{checkable=TRUE} the option is checkable and active by default.}
+\item{chk}{Logical,
+ if \code{TRUE} and \code{checkable=TRUE} the option is checkable and active by default.}
\item{checkable}{Logical, if \code{TRUE} the option can be switched on and off.}
\item{initial}{Character string, the default name for the object should be saved to.
-If \code{"auto"} and a label was provided, an name will be generated automatically from the label.}
+If \code{"auto"} and a label was provided,
+ an name will be generated automatically from the label.}
\item{required}{Logical, whether an entry is mandatory or not.}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.}
+If \code{"auto"} and a label was provided,
+ an ID will be generated automatically from the label.}
-\item{help}{Character string or list of character values and XiMpLe nodes, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string or list of character values and XiMpLe nodes,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.select.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.select.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.select.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -10,18 +10,23 @@
\item{label}{Character string, a text label for this plugin element.}
\item{options}{A named list with options to choose from. The names of the list elements will become
-labels of the options, \code{val} defines the value to submit if the option is selected, and
+labels of the options, \code{val} defines the value to submit if the option is selected,
+ and
\code{chk=TRUE} should be set in the one option which is selected by default. Objects generated with
\code{\link[rkwarddev:rk.XML.option]{rk.XML.option}} are accepted as well.}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.}
+If \code{"auto"} and a label was provided,
+ an ID will be generated automatically from the label.}
-\item{help}{Character string or list of character values and XiMpLe nodes, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string or list of character values and XiMpLe nodes,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.set.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.set.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.set.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -13,7 +13,8 @@
\item{to}{Character string or logical, the value the property should be set to.}
-\item{check.modifiers}{Logical, if \code{TRUE} the given modifiers will be checked for validity. Should only be
+\item{check.modifiers}{Logical,
+ if \code{TRUE} the given modifiers will be checked for validity. Should only be
turned off if you know what you're doing.}
}
\value{
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.snippets.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.snippets.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.snippets.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -12,7 +12,8 @@
An object of class \code{XiMpLe.node}.
}
\description{
-This function will create a snippets node for the document section, with optional child nodes "snippet".
+This function will create a snippets node for the document section,
+ with optional child nodes "snippet".
}
\examples{
# define a formula section with varselector and varslots
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.spinbox.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.spinbox.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.spinbox.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -10,26 +10,34 @@
\arguments{
\item{label}{Character string, a text label for this plugin element.}
-\item{min}{Numeric, the lowest value allowed. Defaults to the lowest value technically representable in the spinbox.}
+\item{min}{Numeric,
+ the lowest value allowed. Defaults to the lowest value technically representable in the spinbox.}
-\item{max}{Numeric, the largest value allowed. Defaults to the highest value technically representable in the spinbox.}
+\item{max}{Numeric,
+ the largest value allowed. Defaults to the highest value technically representable in the spinbox.}
\item{initial}{Numeric, will be used as the initial value.}
\item{real}{Logical, whether values should be real or integer numbers.}
-\item{precision}{Numeric, if \code{real=TRUE} defines the default number of decimal places shown in the spinbox.}
+\item{precision}{Numeric,
+ if \code{real=TRUE} defines the default number of decimal places shown in the spinbox.}
-\item{max.precision}{Numeric, maximum number of digits that can be meaningfully represented.}
+\item{max.precision}{Numeric,
+ maximum number of digits that can be meaningfully represented.}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.}
+If \code{"auto"} and a label was provided,
+ an ID will be generated automatically from the label.}
-\item{help}{Character string or list of character values and XiMpLe nodes, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string or list of character values and XiMpLe nodes,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.switch.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.switch.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.switch.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -17,7 +17,8 @@
Each list must contain either a \code{fixed_value} or a \code{dynamic_value} element.
In addition, each \code{case} list must also have one \code{standard} element.}
-\item{modifier}{Character string, an optional modifier to be appended to \code{condition}.}
+\item{modifier}{Character string,
+ an optional modifier to be appended to \code{condition}.}
\item{id.name}{Character string, a unique ID for this property.
If \code{"auto"}, IDs will be generated automatically from the condition ID.}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.values.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.values.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.values.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -32,16 +32,22 @@
\item{frame.label}{Character string, a text label for the whole frame.}
-\item{id.name}{Character vector, unique IDs for the frame (first entry), the valueselector (second entry)
-and valueslot (third entry). If \code{formula.dependent} is not \code{NULL}, a fourth and fifth entry is needed as well,
+\item{id.name}{Character vector, unique IDs for the frame (first entry),
+ the valueselector (second entry)
+and valueslot (third entry). If \code{formula.dependent} is not \code{NULL},
+ a fourth and fifth entry is needed as well,
for the dependent valueslot and the formula node, respectively.
-If \code{"auto"}, IDs will be generated automatically from \code{label} and \code{slot.text}.}
+If \code{"auto"},
+ IDs will be generated automatically from \code{label} and \code{slot.text}.}
-\item{help}{Character string or list of character values and XiMpLe nodes, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string or list of character values and XiMpLe nodes,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
@@ -51,7 +57,8 @@
\description{
This function will create a <frame> node including a <valueselector> and a <valueslot> node. It is
actually a wrapper for \code{\link[rkwarddev:rk.XML.valueslot]{rk.XML.valueslot}} and
-\code{\link[rkwarddev:rk.XML.valueselector]{rk.XML.valueselector}}, since you usually won't define one
+\code{\link[rkwarddev:rk.XML.valueselector]{rk.XML.valueselector}},
+ since you usually won't define one
without the other.
}
\examples{
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.valueselector.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.valueselector.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.valueselector.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -11,7 +11,8 @@
Must be set if \code{id.name="auto"}.}
\item{options}{A named list with string values to choose from. The names of the list elements will become
-labels of the options, \code{val} defines the value to submit if the value is selected, and
+labels of the options, \code{val} defines the value to submit if the value is selected,
+ and
\code{chk=TRUE} should be set in the one option which is checked by default. Objects generated with
\code{\link[rkwarddev:rk.XML.option]{rk.XML.option}} are accepted as well.}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.valueslot.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.valueslot.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.valueslot.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -4,17 +4,19 @@
\title{Create a XML node "valueslot" for RKWard plugins}
\usage{
rk.XML.valueslot(label, source, property = NULL, required = FALSE,
- multi = FALSE, min = 1, any = 1, max = 0, id.name = "auto",
- help = NULL, component = rk.get.comp())
+ multi = FALSE, duplicates = FALSE, min = 1, any = 1, max = 0,
+ id.name = "auto", help = NULL, component = rk.get.comp())
}
\arguments{
\item{label}{Character string, a text label for the valueslot.}
\item{source}{Either a character string (the \code{id} name of the \code{valueselector} to select values
-from), or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used). If it is not
+from),
+ or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used). If it is not
a \code{<valueselector>} node, you must also specify a valid property for the node.}
-\item{property}{Character string, valid property for a XiMpLe node defined by \code{source}. In the XML code, it
+\item{property}{Character string,
+ valid property for a XiMpLe node defined by \code{source}. In the XML code, it
will cause the use of \code{source_property} instead of \code{source}. Only used if \code{source} ist not a
\code{<valueselector>} node.}
@@ -22,6 +24,9 @@
\item{multi}{Logical, whether the valueslot holds only one or several objects.}
+\item{duplicates}{Logical,
+ if \code{multi=TRUE} defines whether the same entry may be added multiple times. Sets \code{multi=TRUE}.}
+
\item{min}{If \code{multi=TRUE} defines how many objects must be selected. Sets \code{multi=TRUE}.}
\item{any}{If \code{multi=TRUE} defines how many objects must be selected at least if any
@@ -33,11 +38,14 @@
\item{id.name}{Character vector, unique ID for the valueslot.
If \code{"auto"}, the ID will be generated automatically from \code{label}.}
-\item{help}{Character string or list of character values and XiMpLe nodes, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string or list of character values and XiMpLe nodes,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.vars.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.vars.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.vars.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -31,14 +31,19 @@
\item{min.len}{The minimum length, an object needs to have.}
-\item{max.len}{The maximum length, an object needs to have. If \code{NULL}, defaults to the largest
+\item{max.len}{The maximum length, an object needs to have. If \code{NULL},
+ defaults to the largest
integer number representable on the system.}
-\item{classes}{An optional character vector, defining class names to which the selection must be limited.}
+\item{classes}{An optional character vector,
+ defining class names to which the selection must be limited.}
-\item{types}{If you specify one or more variables types here, the varslot will only accept objects of those
-types. Valid types are "unknown", "number", "string", "factor", "invalid". Optional, use with great care,
-the user should not be prevented from making valid choices, and rkward does not always know the type
+\item{types}{If you specify one or more variables types here,
+ the varslot will only accept objects of those
+types. Valid types are "unknown", "number", "string", "factor", "invalid". Optional,
+ use with great care,
+the user should not be prevented from making valid choices,
+ and rkward does not always know the type
of a variable!}
\item{horiz}{Logical. If \code{TRUE}, the varslot will be placed next to the selector,
@@ -48,26 +53,38 @@
\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 its label. Also
-a \code{<formula>} node will be added, using both varslots for \code{fixed_factors} and \code{dependent}
+\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 its label. Also
+a \code{<formula>} node will be added,
+ using both varslots for \code{fixed_factors} and \code{dependent}
respectively.}
-\item{dep.options}{A named list with optional attributes for the \code{dependent} varslot, if \code{formula.dependent}
-is not \code{NULL}. Valid options are \code{required}, \code{multi}, \code{min}, \code{any}, \code{max},
-\code{dim}, \code{min.len}, \code{max.len}, \code{classes} and \code{types}. If an options is undefined, it defaults
+\item{dep.options}{A named list with optional attributes for the \code{dependent} varslot,
+ if \code{formula.dependent}
+is not \code{NULL}. Valid options are \code{required}, \code{multi}, \code{min},
+ \code{any}, \code{max},
+\code{dim}, \code{min.len}, \code{max.len},
+ \code{classes} and \code{types}. If an options is undefined, it defaults
to the same values like the main options of this function.}
-\item{id.name}{Character vector, unique IDs for the frame (first entry), the varselector (second entry)
-and varslot (third entry). If \code{formula.dependent} is not \code{NULL}, a fourth and fifth entry is needed as well,
+\item{id.name}{Character vector, unique IDs for the frame (first entry),
+ the varselector (second entry)
+and varslot (third entry). If \code{formula.dependent} is not \code{NULL},
+ a fourth and fifth entry is needed as well,
for the dependent varslot and the formula node, respectively.
-If \code{"auto"}, IDs will be generated automatically from \code{label} and \code{slot.text}.}
+If \code{"auto"},
+ IDs will be generated automatically from \code{label} and \code{slot.text}.}
-\item{help}{Character string or list of character values and XiMpLe nodes, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string or list of character values and XiMpLe nodes,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
@@ -77,7 +94,8 @@
\description{
This function will create a <frame> node including a <varselector> and a <varslot> node. It is
actually a wrapper for \code{\link[rkwarddev:rk.XML.varslot]{rk.XML.varslot}} and
-\code{\link[rkwarddev:rk.XML.varselector]{rk.XML.varselector}}, since you usually won't define one
+\code{\link[rkwarddev:rk.XML.varselector]{rk.XML.varselector}},
+ since you usually won't define one
without the other.
}
\examples{
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.varslot.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.varslot.Rd 2014-10-26 18:49:27 UTC (rev 4960)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.varslot.Rd 2014-10-26 19:10:53 UTC (rev 4961)
@@ -4,18 +4,20 @@
\title{Create a XML node "varslot" for RKWard plugins}
\usage{
rk.XML.varslot(label, source, property = NULL, required = FALSE,
- multi = FALSE, min = 1, any = 1, max = 0, dim = 0, min.len = 0,
- max.len = NULL, classes = NULL, types = NULL, id.name = "auto",
- help = NULL, component = rk.get.comp())
+ multi = FALSE, duplicates = FALSE, min = 1, any = 1, max = 0,
+ dim = 0, min.len = 0, max.len = NULL, classes = NULL, types = NULL,
+ id.name = "auto", help = NULL, component = rk.get.comp())
}
\arguments{
\item{label}{Character string, a text label for the varslot.}
\item{source}{Either a character string (the \code{id} name of the \code{varselector} to select variables
-from), or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used). If it is not
+from),
+ or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used). If it is not
a \code{<valueselector>} node, you must also specify a valid property for the node.}
-\item{property}{Character string, valid property for a XiMpLe node defined by \code{source}. In the XML code, it
+\item{property}{Character string,
+ valid property for a XiMpLe node defined by \code{source}. In the XML code, it
will cause the use of \code{source_property} instead of \code{source}. Only used if \code{source} ist not a
\code{<valueselector>} node.}
@@ -23,6 +25,9 @@
\item{multi}{Logical, whether the varslot holds only one or several objects.}
+\item{duplicates}{Logical,
+ if \code{multi=TRUE} defines whether the same entry may be added multiple times. Sets \code{multi=TRUE}.}
+
\item{min}{If \code{multi=TRUE} defines how many objects must be selected. Sets \code{multi=TRUE}.}
\item{any}{If \code{multi=TRUE} defines how many objects must be selected at least if any
@@ -36,24 +41,32 @@
\item{min.len}{The minimum length, an object needs to have.}
-\item{max.len}{The maximum length, an object needs to have. If \code{NULL}, defaults to the largest
+\item{max.len}{The maximum length, an object needs to have. If \code{NULL},
+ defaults to the largest
integer number representable on the system.}
-\item{classes}{An optional character vector, defining class names to which the selection must be limited.}
+\item{classes}{An optional character vector,
+ defining class names to which the selection must be limited.}
-\item{types}{If you specify one or more variables types here, the varslot will only accept objects of those
-types. Valid types are "unknown", "number", "string", "factor", "invalid". Optional, use with great care,
-the user should not be prevented from making valid choices, and rkward does not always know the type
+\item{types}{If you specify one or more variables types here,
+ the varslot will only accept objects of those
+types. Valid types are "unknown", "number", "string", "factor", "invalid". Optional,
+ use with great care,
+the user should not be prevented from making valid choices,
+ and rkward does not always know the type
of a variable!}
\item{id.name}{Character vector, unique ID for the varslot.
If \code{"auto"}, the ID will be generated automatically from \code{label}.}
-\item{help}{Character string or list of character values and XiMpLe nodes, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string or list of character values and XiMpLe nodes,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.wizard.Rd
@@ Diff output truncated at 100000 characters. @@
More information about the rkward-tracker
mailing list