[rkward] packages/rkwarddev: bookkeeping
m.eik michalke
meik.michalke at uni-duesseldorf.de
Mon Nov 30 10:01:45 UTC 2015
Git commit 8664767f384e9994dafa868f9c022b9d51c5d6ff by m.eik michalke.
Committed on 30/11/2015 at 10:01.
Pushed by meikm into branch 'master'.
bookkeeping
- i really have to figure out why/how roxygen2 changes its line-wrap all the time
M +4 -5 packages/rkwarddev/DESCRIPTION
M +1 -1 packages/rkwarddev/R/rkwarddev-package.R
M +4 -2 packages/rkwarddev/man/R.comment.Rd
M +20 -10 packages/rkwarddev/man/XiMpLe-methods.Rd
M +8 -4 packages/rkwarddev/man/echo.Rd
M +8 -4 packages/rkwarddev/man/i18n.Rd
M +14 -7 packages/rkwarddev/man/id.Rd
M +8 -4 packages/rkwarddev/man/idq.Rd
M +4 -2 packages/rkwarddev/man/ite.Rd
M +4 -2 packages/rkwarddev/man/join.Rd
M +16 -8 packages/rkwarddev/man/js.Rd
M +2 -1 packages/rkwarddev/man/qp.Rd
M +2 -1 packages/rkwarddev/man/rk.JS.arr-class.Rd
M +6 -3 packages/rkwarddev/man/rk.JS.array.Rd
M +12 -6 packages/rkwarddev/man/rk.JS.doc.Rd
M +6 -3 packages/rkwarddev/man/rk.JS.header.Rd
M +6 -3 packages/rkwarddev/man/rk.JS.opt-class.Rd
M +16 -8 packages/rkwarddev/man/rk.JS.optionset.Rd
M +2 -1 packages/rkwarddev/man/rk.JS.oset-class.Rd
M +10 -5 packages/rkwarddev/man/rk.JS.saveobj.Rd
M +12 -6 packages/rkwarddev/man/rk.JS.scan.Rd
M +8 -4 packages/rkwarddev/man/rk.JS.var-class.Rd
M +22 -11 packages/rkwarddev/man/rk.JS.vars.Rd
M +10 -5 packages/rkwarddev/man/rk.XML.about.Rd
M +2 -1 packages/rkwarddev/man/rk.XML.attribute.Rd
M +16 -8 packages/rkwarddev/man/rk.XML.browser.Rd
M +8 -4 packages/rkwarddev/man/rk.XML.cbox.Rd
M +4 -2 packages/rkwarddev/man/rk.XML.component.Rd
M +2 -1 packages/rkwarddev/man/rk.XML.components.Rd
M +12 -6 packages/rkwarddev/man/rk.XML.connect.Rd
M +6 -3 packages/rkwarddev/man/rk.XML.convert.Rd
M +2 -1 packages/rkwarddev/man/rk.XML.copy.Rd
M +4 -2 packages/rkwarddev/man/rk.XML.dependencies.Rd
M +4 -2 packages/rkwarddev/man/rk.XML.dependency_check.Rd
M +10 -5 packages/rkwarddev/man/rk.XML.dialog.Rd
M +12 -6 packages/rkwarddev/man/rk.XML.dropdown.Rd
M +10 -5 packages/rkwarddev/man/rk.XML.embed.Rd
M +2 -1 packages/rkwarddev/man/rk.XML.formula.Rd
M +6 -3 packages/rkwarddev/man/rk.XML.frame.Rd
M +10 -5 packages/rkwarddev/man/rk.XML.input.Rd
M +4 -2 packages/rkwarddev/man/rk.XML.logic.Rd
M +20 -10 packages/rkwarddev/man/rk.XML.matrix.Rd
M +6 -3 packages/rkwarddev/man/rk.XML.menu.Rd
M +6 -3 packages/rkwarddev/man/rk.XML.option.Rd
M +18 -9 packages/rkwarddev/man/rk.XML.optioncolumn.Rd
M +18 -9 packages/rkwarddev/man/rk.XML.optionset.Rd
M +6 -3 packages/rkwarddev/man/rk.XML.page.Rd
M +16 -8 packages/rkwarddev/man/rk.XML.plugin.Rd
M +28 -14 packages/rkwarddev/man/rk.XML.pluginmap.Rd
M +2 -1 packages/rkwarddev/man/rk.XML.preview.Rd
M +10 -5 packages/rkwarddev/man/rk.XML.radio.Rd
M +4 -2 packages/rkwarddev/man/rk.XML.require.Rd
M +14 -7 packages/rkwarddev/man/rk.XML.saveobj.Rd
M +12 -6 packages/rkwarddev/man/rk.XML.select.Rd
M +2 -1 packages/rkwarddev/man/rk.XML.set.Rd
M +2 -1 packages/rkwarddev/man/rk.XML.snippets.Rd
M +18 -9 packages/rkwarddev/man/rk.XML.spinbox.Rd
M +2 -1 packages/rkwarddev/man/rk.XML.switch.Rd
M +4 -2 packages/rkwarddev/man/rk.XML.tabbook.Rd
M +18 -9 packages/rkwarddev/man/rk.XML.values.Rd
M +4 -2 packages/rkwarddev/man/rk.XML.valueselector.Rd
M +14 -7 packages/rkwarddev/man/rk.XML.valueslot.Rd
M +38 -19 packages/rkwarddev/man/rk.XML.vars.Rd
M +2 -1 packages/rkwarddev/man/rk.XML.varselector.Rd
M +24 -12 packages/rkwarddev/man/rk.XML.varslot.Rd
M +8 -4 packages/rkwarddev/man/rk.XML.wizard.Rd
M +6 -3 packages/rkwarddev/man/rk.build.plugin.Rd
M +6 -3 packages/rkwarddev/man/rk.get.rkh.prompter.Rd
M +4 -2 packages/rkwarddev/man/rk.local.Rd
M +28 -14 packages/rkwarddev/man/rk.paste.JS.Rd
M +12 -6 packages/rkwarddev/man/rk.paste.JS.graph.Rd
M +10 -5 packages/rkwarddev/man/rk.plotOptions.Rd
M +48 -24 packages/rkwarddev/man/rk.plugin.component.Rd
M +64 -32 packages/rkwarddev/man/rk.plugin.skeleton.Rd
M +2 -1 packages/rkwarddev/man/rk.rkh.doc.Rd
M +8 -4 packages/rkwarddev/man/rk.rkh.scan.Rd
M +2 -1 packages/rkwarddev/man/rk.rkh.section.Rd
M +2 -1 packages/rkwarddev/man/rk.rkh.setting.Rd
M +2 -1 packages/rkwarddev/man/rk.rkh.settings.Rd
M +2 -1 packages/rkwarddev/man/rk.set.comp.Rd
M +2 -1 packages/rkwarddev/man/rk.set.empty.e.Rd
M +2 -1 packages/rkwarddev/man/rk.set.indent.Rd
M +12 -6 packages/rkwarddev/man/rk.set.rkh.prompter.Rd
M +4 -2 packages/rkwarddev/man/rk.updatePluginMessages.Rd
M +1 -1 packages/rkwarddev/man/rkwarddev-package.Rd
M +2 -1 packages/rkwarddev/man/rkwarddev.required.Rd
M +24 -12 packages/rkwarddev/man/tf.Rd
http://commits.kde.org/rkward/8664767f384e9994dafa868f9c022b9d51c5d6ff
diff --git a/packages/rkwarddev/DESCRIPTION b/packages/rkwarddev/DESCRIPTION
index 442d856..dea52e2 100644
--- a/packages/rkwarddev/DESCRIPTION
+++ b/packages/rkwarddev/DESCRIPTION
@@ -8,16 +8,15 @@ Depends:
Suggests:
testthat
Enhances: rkward
-Description: Provides functions to create plugin skeletons and XML
- structures for RKWard.
+Description: Provides functions to create plugin skeletons and XML structures
+ for RKWard.
License: GPL (>= 3)
Encoding: UTF-8
LazyLoad: yes
URL: https://rkward.kde.org
-Authors at R: c(person(given="m.eik", family="michalke",
- email="meik.michalke at hhu.de", role=c("aut", "cre", "cph")))
+Authors at R: c(person(given="m.eik", family="michalke", email="meik.michalke at hhu.de", role=c("aut", "cre", "cph")))
Version: 0.08-1
-Date: 2015-11-28
+Date: 2015-11-30
RoxygenNote: 5.0.1
Collate:
'00_class_01_rk.JS.arr.R'
diff --git a/packages/rkwarddev/R/rkwarddev-package.R b/packages/rkwarddev/R/rkwarddev-package.R
index 572eb0b..d980dbc 100644
--- a/packages/rkwarddev/R/rkwarddev-package.R
+++ b/packages/rkwarddev/R/rkwarddev-package.R
@@ -4,7 +4,7 @@
#' Package: \tab rkwarddev\cr
#' Type: \tab Package\cr
#' Version: \tab 0.08-1\cr
-#' Date: \tab 2015-11-28\cr
+#' Date: \tab 2015-11-30\cr
#' Depends: \tab R (>= 2.9.0),methods,XiMpLe (>= 0.03-21),rkward (>= 0.5.7)\cr
#' Enhances: \tab rkward\cr
#' Encoding: \tab UTF-8\cr
diff --git a/packages/rkwarddev/man/R.comment.Rd b/packages/rkwarddev/man/R.comment.Rd
index f41ec41..f211942 100644
--- a/packages/rkwarddev/man/R.comment.Rd
+++ b/packages/rkwarddev/man/R.comment.Rd
@@ -13,9 +13,11 @@ R.comment(..., indent.by = rk.get.indent(escape = TRUE), level = 2,
\item{indent.by}{A character string defining the indentation string to use. Note that
backslashes need to be escaped (e.g. \code{"\\t"} to produce \code{"\t"}).}
-\item{level}{Integer, which indentation level to use in the resulting R code, minimum is 1.}
+\item{level}{Integer, which indentation level to use in the resulting R code,
+ minimum is 1.}
-\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.
diff --git a/packages/rkwarddev/man/XiMpLe-methods.Rd b/packages/rkwarddev/man/XiMpLe-methods.Rd
index 2436807..71f651b 100644
--- a/packages/rkwarddev/man/XiMpLe-methods.Rd
+++ b/packages/rkwarddev/man/XiMpLe-methods.Rd
@@ -25,26 +25,33 @@ plugin2script(obj, prefix = "rkdev", indent = TRUE, level = 1,
level = 1, drop.defaults = TRUE, node.names = TRUE, collapse = ".")
}
\arguments{
-\item{obj}{Either a character vector (path to a plugin XML file to parse), a connection, an already
+\item{obj}{Either a character vector (path to a plugin XML file to parse), a connection,
+ an already
parsed XML tree (class \code{XiMpLe.doc}) or a single \code{XiMpLe.node} object.}
-\item{prefix}{Character string, used as the prefix for the object names used in the script. Set to \code{""}
+\item{prefix}{Character string,
+ used as the prefix for the object names used in the script. Set to \code{""}
to disable the prefix.}
\item{indent}{Logical, whether the script code should be indented properly.}
\item{level}{Integer number, the starting leven of indentation.}
-\item{drop.defaults}{Logical, whether to check for the default options in function calls. If the
-parsed and translated XML code resulted in default options, they are omitted in the resulting script.}
+\item{drop.defaults}{Logical,
+ whether to check for the default options in function calls. If the
+parsed and translated XML code resulted in default options,
+ they are omitted in the resulting script.}
-\item{node.names}{Logical, whether the node names should become part of the generated R object names.}
+\item{node.names}{Logical,
+ whether the node names should become part of the generated R object names.}
-\item{collapse}{Character string, used to collapse the parts of the generated R object names.}
+\item{collapse}{Character string,
+ used to collapse the parts of the generated R object names.}
}
\value{
Either a character vector (if \code{obj} is a single XML node)
- or a list of character vectors named \code{"logic"}, \code{"dialog"}, and \code{"wizard"},
+ or a list of character vectors named \code{"logic"}, \code{"dialog"},
+ and \code{"wizard"},
(if \code{obj} is a full XML document).
}
\description{
@@ -52,17 +59,20 @@ These methods try to translate plugin XML objects into \code{rkwarddev} function
}
\details{
They are intended to make it easier to translate previously manually maintained plugin code
-into \code{rkwarddev} scripts. The generated output should not be used as-is, but restructured
+into \code{rkwarddev} scripts. The generated output should not be used as-is,
+ but restructured
properly into a useful script.
You can either use a full XML document (read with \code{\link[XiMpLe:parseXMLTree]{parseXMLTree}})
-or single (also nested) XiMpLe XML nodes. If you provide a character string, it is assumed to be
+or single (also nested) XiMpLe XML nodes. If you provide a character string,
+ it is assumed to be
the full path to a document to be parsed with \code{parseXMLTree} and then analysed. Connections
are also accepted.
}
\note{
The methods might fail, especially with highly complex plugins. Try to break these
-into sensible chunks and try those speparately. Sometimes, slightly changing the input file
+into sensible chunks and try those speparately. Sometimes,
+ slightly changing the input file
might also do the trick to get some usable results.
}
\examples{
diff --git a/packages/rkwarddev/man/echo.Rd b/packages/rkwarddev/man/echo.Rd
index 8779e89..27b3e00 100644
--- a/packages/rkwarddev/man/echo.Rd
+++ b/packages/rkwarddev/man/echo.Rd
@@ -8,16 +8,20 @@ echo(..., newline = "")
}
\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{
diff --git a/packages/rkwarddev/man/i18n.Rd b/packages/rkwarddev/man/i18n.Rd
index 41454c7..50c8608 100644
--- a/packages/rkwarddev/man/i18n.Rd
+++ b/packages/rkwarddev/man/i18n.Rd
@@ -7,11 +7,14 @@
i18n(msgid, ..., context = NULL, plural = NULL, newline = "")
}
\arguments{
-\item{msgid}{Either a character string, the message to be translated (if applicable, its singular form),
-or an object of class \code{\link[base:noquote]{noquote}}, which will be pasted as a \code{noquote()} function call.}
+\item{msgid}{Either a character string, the message to be translated (if applicable,
+ its singular form),
+or an object of class \code{\link[base:noquote]{noquote}},
+ which will be pasted as a \code{noquote()} function call.}
\item{...}{Either character string which will be pasted unquoted to be used in conjunctions with
-placeholders in msgid, or XiMpLe.node objects of which the JavaScript variable name will be
+placeholders in msgid,
+ or XiMpLe.node objects of which the JavaScript variable name will be
used.}
\item{context}{Character string, optional context information for this string.}
@@ -19,7 +22,8 @@ used.}
\item{plural}{Character string for plural form of \code{msgid}, must at least include one
placeholder, and the first one has to represent an integer value in the dialog.}
-\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{
An object of class \code{rk.JS.i18n}.
diff --git a/packages/rkwarddev/man/id.Rd b/packages/rkwarddev/man/id.Rd
index 6e429db..0a0b976 100644
--- a/packages/rkwarddev/man/id.Rd
+++ b/packages/rkwarddev/man/id.Rd
@@ -8,17 +8,22 @@ id(..., quote = FALSE, collapse = "", js = TRUE, .objects = list(...))
}
\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, if the character strings should be deparsed, so they come out "as-is" when
+\item{quote}{Logical, if the character strings should 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.}
-\item{.objects}{Alternative way of specifying objects, if you already have them as a list.}
+\item{.objects}{Alternative way of specifying objects,
+ if you already have them as a list.}
}
\value{
A character string.
@@ -26,8 +31,10 @@ A character string.
\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{
diff --git a/packages/rkwarddev/man/idq.Rd b/packages/rkwarddev/man/idq.Rd
index e67757e..7805abe 100644
--- a/packages/rkwarddev/man/idq.Rd
+++ b/packages/rkwarddev/man/idq.Rd
@@ -12,10 +12,12 @@ idq(obj, modifiers = NULL, check.modifiers = TRUE, js = TRUE,
\item{modifiers}{A character vector with modifiers you'd like to apply to the XML node property.}
-\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{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.}
\item{quote}{Character string to be used for quoting.}
@@ -25,10 +27,12 @@ A character string.
}
\description{
This is actually a convenience wrapper for \code{\link[rkwarddev:id]{id}}
-and returns the XML ID of XiMpLe nodes in quoted format, optionally with an attached modifier.
+and returns the XML ID of XiMpLe nodes in quoted format,
+ optionally with an attached modifier.
}
\details{
-You can use this function to write almost literal JavaScript code, but still be able to extract IDs from
+You can use this function to write almost literal JavaScript code,
+ but still be able to extract IDs from
generated R objects.
}
\note{
diff --git a/packages/rkwarddev/man/ite.Rd b/packages/rkwarddev/man/ite.Rd
index 45bf676..1fd529e 100644
--- a/packages/rkwarddev/man/ite.Rd
+++ b/packages/rkwarddev/man/ite.Rd
@@ -10,12 +10,14 @@ ite(ifjs, thenjs, elsejs = NULL)
\item{ifjs}{Either a character string to be placed in the brackets of 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}
diff --git a/packages/rkwarddev/man/join.Rd b/packages/rkwarddev/man/join.Rd
index acdeddc..da47ae8 100644
--- a/packages/rkwarddev/man/join.Rd
+++ b/packages/rkwarddev/man/join.Rd
@@ -18,8 +18,10 @@ An object of class \code{rk.JS.echo}.
}
\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{
diff --git a/packages/rkwarddev/man/js.Rd b/packages/rkwarddev/man/js.Rd
index c403b2f..89898aa 100644
--- a/packages/rkwarddev/man/js.Rd
+++ b/packages/rkwarddev/man/js.Rd
@@ -18,29 +18,37 @@ JavaScript operators and \code{if} conditions will be kept as-is.}
\item{linebreaks}{Logical, should there be line breaks between the elements in this call?}
-\item{empty.e}{For \code{if} conditions only: Logical, if \code{TRUE} will force to add empty \code{else \{\}} brackets when
-there is no \code{else} statement defined, which is considered to enhance code readability by some.}
+\item{empty.e}{For \code{if} conditions only: Logical,
+ if \code{TRUE} will force to add empty \code{else \{\}} brackets when
+there is no \code{else} statement defined,
+ which is considered to enhance code readability by some.}
-\item{keep.ite}{Logical, if \code{TRUE} returns \code{if/else} conditions in a list of objects of class \code{rk.JS.ite} instead
+\item{keep.ite}{Logical,
+ if \code{TRUE} returns \code{if/else} conditions in a list of objects of class \code{rk.JS.ite} instead
of a pasted character string. Comes in handy if used inside \code{\link[rkwarddev:rk.JS.options]{rk.JS.options}}.}
}
\value{
-A character string (or \code{rk.JS.ite}, if \code{keep.ite=TRUE} and input is an \code{if/else} condition).
+A character string (or \code{rk.JS.ite},
+ if \code{keep.ite=TRUE} and input is an \code{if/else} condition).
}
\description{
This function is a wrapper for \code{\link[rkwarddev:id]{id}} similar to \code{\link[rkwarddev:qp]{qp}}
that uses \code{eval(substitute(alist(...)))} to preserve the value of \code{...} as-is to be able to
-both keep operators like \code{">="} or \code{"!="} unevaluated in the resulting output, as well as translating
+both keep operators like \code{">="} or \code{"!="} unevaluated in the resulting output,
+ as well as translating
\code{if/else} clauses from R to JavaScript.
}
\details{
-Normally, \code{id} would simply evaluate the condition and then return the result of that evaluation, which
-most of the time is not what you want. With this function, you can test conditions in usual R syntax, yet
+Normally,
+ \code{id} would simply evaluate the condition and then return the result of that evaluation, which
+most of the time is not what you want. With this function,
+ you can test conditions in usual R syntax, yet
the operators and \code{if/else} clauses will end up pasted in the result.
The following operators are supported: +, -, *, /, ==, !=, >, <, >=, <=, || and &&
-These are currently unsupported and still need to be quoted: \%, ++, --, =, +=, -=, *=, /=, \%=, ===, !== and !
+These are currently unsupported and still need to be quoted: \%, ++, --, =, +=, -=, *=,
+ /=, \%=, ===, !== and !
}
\note{
You should nest your plugin script inside \code{\link[rkwarddev:rk.local]{rk.local}} if you're
diff --git a/packages/rkwarddev/man/qp.Rd b/packages/rkwarddev/man/qp.Rd
index 4dc0554..9a4bbf9 100644
--- a/packages/rkwarddev/man/qp.Rd
+++ b/packages/rkwarddev/man/qp.Rd
@@ -8,7 +8,8 @@ qp(...)
}
\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.
diff --git a/packages/rkwarddev/man/rk.JS.arr-class.Rd b/packages/rkwarddev/man/rk.JS.arr-class.Rd
index 8bf44f3..92df61d 100644
--- a/packages/rkwarddev/man/rk.JS.arr-class.Rd
+++ b/packages/rkwarddev/man/rk.JS.arr-class.Rd
@@ -26,7 +26,8 @@ need to temper with this type of class manually.
\item{\code{option}}{Character string, name of the option to set.}
-\item{\code{opt.sep}}{Character string, separates previous options from the one defined by the array.}
+\item{\code{opt.sep}}{Character string,
+ separates previous options from the one defined by the array.}
}}
\keyword{Classes}
diff --git a/packages/rkwarddev/man/rk.JS.array.Rd b/packages/rkwarddev/man/rk.JS.array.Rd
index b636d00..1b2df14 100644
--- a/packages/rkwarddev/man/rk.JS.array.Rd
+++ b/packages/rkwarddev/man/rk.JS.array.Rd
@@ -14,15 +14,18 @@ constructed from several variables.}
\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).}
-\item{opt.sep}{Character string, will be printed in the resulting R code before the option name.}
+\item{opt.sep}{Character string,
+ will be printed in the resulting R code before the option name.}
}
\value{
An object of class \code{rk.JS.arr}.
diff --git a/packages/rkwarddev/man/rk.JS.doc.Rd b/packages/rkwarddev/man/rk.JS.doc.Rd
index 1ba9d6f..7d6b363 100644
--- a/packages/rkwarddev/man/rk.JS.doc.Rd
+++ b/packages/rkwarddev/man/rk.JS.doc.Rd
@@ -17,7 +17,8 @@ rk.JS.doc(require = c(), variables = NULL, globals = NULL,
or a (list of) objects 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.
@@ -33,14 +34,18 @@ pasted as-is, after \code{require} has been evaluated.}
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,
@@ -50,7 +55,8 @@ which will then also be added to the comment.}
\item{indent.by}{A character string defining how indentation should be done.}
-\item{guess.getter}{Locigal, if \code{TRUE} try to get a good default getter function for JavaScript
+\item{guess.getter}{Locigal,
+ if \code{TRUE} try to get a good default getter function for JavaScript
variable values. Only used if \code{header.add} contains XiMpLe nodes.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.JS.header.Rd b/packages/rkwarddev/man/rk.JS.header.Rd
index b6e1296..720505e 100644
--- a/packages/rkwarddev/man/rk.JS.header.Rd
+++ b/packages/rkwarddev/man/rk.JS.header.Rd
@@ -13,17 +13,20 @@ nested in an i18n() call.}
\item{...}{An optional number of additional info to add to the header. Each entry must be named \code{add}
or \code{addFromUI} -- note that you can use multiple entries with the same name here. Entries named
-\code{add} must be vectors of legth 2, the first being the caption (character), the second its value (either
+\code{add} must be vectors of legth 2, the first being the caption (character),
+ the second its value (either
character or a XiMpLe node from the dialog); if the second value is named \code{noquote} or \code{nq},
the JS output will be nested inside \code{noquote()}. Entries named \code{addFromUI} must have exactly one value
specifying the GUI element to query (either character or a XiMpLe node from the dialog).}
\item{level}{Integer, if not \code{NULL} will be added as the header level.}
-\item{guess.getter}{Locigal, if \code{TRUE} try to get a good default getter function for JavaScript
+\item{guess.getter}{Locigal,
+ if \code{TRUE} try to get a good default getter function for JavaScript
variable values.}
-\item{.add}{Same as \code{...}, but provided as a single list. If used, values will be appended to \code{...}.}
+\item{.add}{Same as \code{...}, but provided as a single list. If used,
+ values will be appended to \code{...}.}
}
\value{
A character string.
diff --git a/packages/rkwarddev/man/rk.JS.opt-class.Rd b/packages/rkwarddev/man/rk.JS.opt-class.Rd
index 7380771..c5db645 100644
--- a/packages/rkwarddev/man/rk.JS.opt-class.Rd
+++ b/packages/rkwarddev/man/rk.JS.opt-class.Rd
@@ -16,15 +16,18 @@ type of class manually.
\item{\code{opt.name}}{Character string, the name of the option.}
-\item{\code{collapse}}{Character string, used to collapse several options into one string.}
+\item{\code{collapse}}{Character string,
+ used to collapse several options into one string.}
\item{\code{ifs}}{A list with objects of class rk.JS.ite.}
\item{\code{array}}{Logical, whether to use an array for options.}
-\item{\code{funct}}{Character string, name of the R function to be called to combine the options.}
+\item{\code{funct}}{Character string,
+ name of the R function to be called to combine the options.}
-\item{\code{opt.sep}}{Character string, separates previous options from the one defined here.}
+\item{\code{opt.sep}}{Character string,
+ separates previous options from the one defined here.}
}}
\keyword{Classes}
diff --git a/packages/rkwarddev/man/rk.JS.optionset.Rd b/packages/rkwarddev/man/rk.JS.optionset.Rd
index f889eeb..47c6dcb 100644
--- a/packages/rkwarddev/man/rk.JS.optionset.Rd
+++ b/packages/rkwarddev/man/rk.JS.optionset.Rd
@@ -10,29 +10,36 @@ rk.JS.optionset(optionset, ..., loopvar = "i", collapse = ",\\\\n\\\\t",
\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{
@@ -48,7 +55,8 @@ dep.optionset.packages <- rk.XML.optionset(
)
)), 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")
diff --git a/packages/rkwarddev/man/rk.JS.oset-class.Rd b/packages/rkwarddev/man/rk.JS.oset-class.Rd
index 6737fcb..d00f045 100644
--- a/packages/rkwarddev/man/rk.JS.oset-class.Rd
+++ b/packages/rkwarddev/man/rk.JS.oset-class.Rd
@@ -20,7 +20,8 @@ type of class manually.
\item{\code{body}}{A list of JavaScript code, the body of the for loop.}
-\item{\code{collapse}}{Character string, how all optioncolumns should be concatenated on the R code level.}
+\item{\code{collapse}}{Character string,
+ how all optioncolumns should be concatenated on the R code level.}
}}
\keyword{Classes}
diff --git a/packages/rkwarddev/man/rk.JS.saveobj.Rd b/packages/rkwarddev/man/rk.JS.saveobj.Rd
index a25ad5f..038f2d7 100644
--- a/packages/rkwarddev/man/rk.JS.saveobj.Rd
+++ b/packages/rkwarddev/man/rk.JS.saveobj.Rd
@@ -8,15 +8,20 @@ rk.JS.saveobj(pXML, R.objects = "initial", vars = TRUE,
add.abbrev = FALSE, indent.by = rk.get.indent())
}
\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.}
diff --git a/packages/rkwarddev/man/rk.JS.scan.Rd b/packages/rkwarddev/man/rk.JS.scan.Rd
index c81153c..f59a471 100644
--- a/packages/rkwarddev/man/rk.JS.scan.Rd
+++ b/packages/rkwarddev/man/rk.JS.scan.Rd
@@ -8,18 +8,24 @@ rk.JS.scan(pXML, js = TRUE, add.abbrev = FALSE, guess.getter = FALSE,
indent.by = rk.get.indent())
}
\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}.}
}
diff --git a/packages/rkwarddev/man/rk.JS.var-class.Rd b/packages/rkwarddev/man/rk.JS.var-class.Rd
index 9c8b4a8..2d90032 100644
--- a/packages/rkwarddev/man/rk.JS.var-class.Rd
+++ b/packages/rkwarddev/man/rk.JS.var-class.Rd
@@ -20,15 +20,19 @@ type of class manually.
\item{\code{modifiers}}{A list of modifiers to apply to the XML node property.}
-\item{\code{default}}{Logical, whether the default value (no special modifier) of the node should also be defined.}
+\item{\code{default}}{Logical,
+ whether the default value (no special modifier) of the node should also be defined.}
-\item{\code{append.modifier}}{Logical, if a modifier is given, should that become part of the variable name?}
+\item{\code{append.modifier}}{Logical, if a modifier is given,
+ should that become part of the variable name?}
-\item{\code{join}}{Character string, if set is used to collapse multiple values into one string.}
+\item{\code{join}}{Character string,
+ if set is used to collapse multiple values into one string.}
\item{\code{vars}}{A list of objects of class rk.JS.var.}
-\item{\code{getter}}{Character string, the JavaScript function which should be used to fetch the values from the plugin.}
+\item{\code{getter}}{Character string,
+ the JavaScript function which should be used to fetch the values from the plugin.}
}}
\keyword{Classes}
diff --git a/packages/rkwarddev/man/rk.JS.vars.Rd b/packages/rkwarddev/man/rk.JS.vars.Rd
index 93035b6..db7b344 100644
--- a/packages/rkwarddev/man/rk.JS.vars.Rd
+++ b/packages/rkwarddev/man/rk.JS.vars.Rd
@@ -16,26 +16,37 @@ or objects of class \code{XiMpLe.node} with plugin XML nodes (whose ID will be e
\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.}
-\item{object.name}{Logical, if \code{TRUE} the JS variable name will roughly match the R object name. If the
-object name contains dots, they will be removed and the JS name printed in camel code instead. Use this option
-with great caution and do not combine it with \code{\link[rkwarddev:rk.JS.scan]{rk.JS.scan}}, as it will likely result
+\item{object.name}{Logical,
+ if \code{TRUE} the JS variable name will roughly match the R object name. If the
+object name contains dots,
+ they will be removed and the JS name printed in camel code instead. Use this option
+with great caution and do not combine it with \code{\link[rkwarddev:rk.JS.scan]{rk.JS.scan}},
+ as it will likely result
in unusable code. \code{rk.JS.scan} examines XML nodes and therefore does not know any R object names.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.about.Rd b/packages/rkwarddev/man/rk.XML.about.Rd
index f2ab7a8..0ffe9ce 100644
--- a/packages/rkwarddev/man/rk.XML.about.Rd
+++ b/packages/rkwarddev/man/rk.XML.about.Rd
@@ -17,9 +17,11 @@ rk.XML.about(name, author, about = list(desc = "SHORT_DESCRIPTION", version =
\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{
@@ -32,11 +34,14 @@ See \code{\link[utils:person]{person}} for more details on this, especially for
\item{long.desc}{A long description (optional, defaults to \code{desc})}
}}
-\item{dependencies}{Deprecated, use \code{\link[rkwarddev:rk.XML.dependencies]{rk.XML.dependencies}} instead.}
+\item{dependencies}{Deprecated,
+ use \code{\link[rkwarddev:rk.XML.dependencies]{rk.XML.dependencies}} instead.}
-\item{package}{Deprecated, use \code{\link[rkwarddev:rk.XML.dependencies]{rk.XML.dependencies}} instead.}
+\item{package}{Deprecated,
+ use \code{\link[rkwarddev:rk.XML.dependencies]{rk.XML.dependencies}} instead.}
-\item{pluginmap}{Deprecated, use \code{\link[rkwarddev:rk.XML.dependencies]{rk.XML.dependencies}} instead.}
+\item{pluginmap}{Deprecated,
+ use \code{\link[rkwarddev:rk.XML.dependencies]{rk.XML.dependencies}} instead.}
}
\description{
Create XML node "about" for RKWard pluginmaps
diff --git a/packages/rkwarddev/man/rk.XML.attribute.Rd b/packages/rkwarddev/man/rk.XML.attribute.Rd
index 6cb1f01..1954fb9 100644
--- a/packages/rkwarddev/man/rk.XML.attribute.Rd
+++ b/packages/rkwarddev/man/rk.XML.attribute.Rd
@@ -15,7 +15,8 @@ or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and
\item{label}{Character string, label associated with the attribute.}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.browser.Rd b/packages/rkwarddev/man/rk.XML.browser.Rd
index b0bf75b..92f50f5 100644
--- a/packages/rkwarddev/man/rk.XML.browser.Rd
+++ b/packages/rkwarddev/man/rk.XML.browser.Rd
@@ -11,30 +11,38 @@ rk.XML.browser(label, type = "file", initial = NULL, urls = FALSE,
\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!}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.cbox.Rd b/packages/rkwarddev/man/rk.XML.cbox.Rd
index 6c3fab1..c963746 100644
--- a/packages/rkwarddev/man/rk.XML.cbox.Rd
+++ b/packages/rkwarddev/man/rk.XML.cbox.Rd
@@ -20,16 +20,20 @@ rk.XML.cbox(label, value = "true", un.value = NULL, chk = FALSE,
\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!}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.component.Rd b/packages/rkwarddev/man/rk.XML.component.Rd
index 3b476db..17970eb 100644
--- a/packages/rkwarddev/man/rk.XML.component.Rd
+++ b/packages/rkwarddev/man/rk.XML.component.Rd
@@ -15,14 +15,16 @@ rk.XML.component(label, file, id.name = "auto", type = "standard",
\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.
See \code{\link[rkwarddev:rk.XML.dependencies]{rk.XML.dependencies}} for details. Skipped if \code{NULL}.}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.components.Rd b/packages/rkwarddev/man/rk.XML.components.Rd
index fa42461..28b6211 100644
--- a/packages/rkwarddev/man/rk.XML.components.Rd
+++ b/packages/rkwarddev/man/rk.XML.components.Rd
@@ -13,7 +13,8 @@ rk.XML.components(...)
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")
diff --git a/packages/rkwarddev/man/rk.XML.connect.Rd b/packages/rkwarddev/man/rk.XML.connect.Rd
index 5f6e591..6a9b031 100644
--- a/packages/rkwarddev/man/rk.XML.connect.Rd
+++ b/packages/rkwarddev/man/rk.XML.connect.Rd
@@ -9,21 +9,27 @@ rk.XML.connect(governor, client, get = "state", set = "enabled",
}
\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{
diff --git a/packages/rkwarddev/man/rk.XML.convert.Rd b/packages/rkwarddev/man/rk.XML.convert.Rd
index b422cda..ac4c322 100644
--- a/packages/rkwarddev/man/rk.XML.convert.Rd
+++ b/packages/rkwarddev/man/rk.XML.convert.Rd
@@ -10,7 +10,8 @@ rk.XML.convert(sources, mode = c(), required = FALSE, id.name = "auto")
\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:
@@ -28,7 +29,8 @@ or at least one of these elemets:
\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.
@@ -39,7 +41,8 @@ and \code{mode} value.}
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 see \code{\link[rkwarddev:modifiers]{modifiers}}.
diff --git a/packages/rkwarddev/man/rk.XML.copy.Rd b/packages/rkwarddev/man/rk.XML.copy.Rd
index cd8444d..e85d8df 100644
--- a/packages/rkwarddev/man/rk.XML.copy.Rd
+++ b/packages/rkwarddev/man/rk.XML.copy.Rd
@@ -10,7 +10,8 @@ rk.XML.copy(id, as = NULL)
\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").}
}
diff --git a/packages/rkwarddev/man/rk.XML.dependencies.Rd b/packages/rkwarddev/man/rk.XML.dependencies.Rd
index a886e35..b98cb04 100644
--- a/packages/rkwarddev/man/rk.XML.dependencies.Rd
+++ b/packages/rkwarddev/man/rk.XML.dependencies.Rd
@@ -32,13 +32,15 @@ rk.XML.dependencies(dependencies = NULL, package = NULL, pluginmap = NULL,
\item{url}{URL to get the pluginmap (required)}
}}
-\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{
diff --git a/packages/rkwarddev/man/rk.XML.dependency_check.Rd b/packages/rkwarddev/man/rk.XML.dependency_check.Rd
index 3edaa8e..6021665 100644
--- a/packages/rkwarddev/man/rk.XML.dependency_check.Rd
+++ b/packages/rkwarddev/man/rk.XML.dependency_check.Rd
@@ -32,13 +32,15 @@ rk.XML.dependency_check(id.name, dependencies = NULL, package = NULL,
\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{
diff --git a/packages/rkwarddev/man/rk.XML.dialog.Rd b/packages/rkwarddev/man/rk.XML.dialog.Rd
index 974ba22..e48fba5 100644
--- a/packages/rkwarddev/man/rk.XML.dialog.Rd
+++ b/packages/rkwarddev/man/rk.XML.dialog.Rd
@@ -11,21 +11,26 @@ rk.XML.dialog(..., label = NULL, recommended = FALSE, i18n = NULL)
\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.}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\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{
diff --git a/packages/rkwarddev/man/rk.XML.dropdown.Rd b/packages/rkwarddev/man/rk.XML.dropdown.Rd
index 48907e3..f3b9ce0 100644
--- a/packages/rkwarddev/man/rk.XML.dropdown.Rd
+++ b/packages/rkwarddev/man/rk.XML.dropdown.Rd
@@ -12,24 +12,30 @@ rk.XML.dropdown(label, options = list(label = c(val = "", chk = FALSE, i18n =
\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. You might also provide an \code{i18n}
for this particular option (see \code{i18n}). 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!}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.embed.Rd b/packages/rkwarddev/man/rk.XML.embed.Rd
index 77d9f3f..37ff33a 100644
--- a/packages/rkwarddev/man/rk.XML.embed.Rd
+++ b/packages/rkwarddev/man/rk.XML.embed.Rd
@@ -8,17 +8,22 @@ rk.XML.embed(component, button = FALSE, label = "Options",
id.name = "auto", i18n = NULL)
}
\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.}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.formula.Rd b/packages/rkwarddev/man/rk.XML.formula.Rd
index cd5e024..ae6df7a 100644
--- a/packages/rkwarddev/man/rk.XML.formula.Rd
+++ b/packages/rkwarddev/man/rk.XML.formula.Rd
@@ -12,7 +12,8 @@ rk.XML.formula(fixed, dependent, id.name = "auto")
\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}.
diff --git a/packages/rkwarddev/man/rk.XML.frame.Rd b/packages/rkwarddev/man/rk.XML.frame.Rd
index 43d1cc3..4dda697 100644
--- a/packages/rkwarddev/man/rk.XML.frame.Rd
+++ b/packages/rkwarddev/man/rk.XML.frame.Rd
@@ -14,15 +14,18 @@ rk.XML.frame(..., label = NULL, checkable = FALSE, chk = TRUE,
\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.}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.input.Rd b/packages/rkwarddev/man/rk.XML.input.Rd
index 85af53a..4b61d1a 100644
--- a/packages/rkwarddev/man/rk.XML.input.Rd
+++ b/packages/rkwarddev/man/rk.XML.input.Rd
@@ -10,7 +10,8 @@ rk.XML.input(label, initial = NULL, size = "medium", required = FALSE,
\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".}
@@ -19,16 +20,20 @@ rk.XML.input(label, initial = NULL, size = "medium", required = FALSE,
\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!}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.logic.Rd b/packages/rkwarddev/man/rk.XML.logic.Rd
index 692a061..667e007 100644
--- a/packages/rkwarddev/man/rk.XML.logic.Rd
+++ b/packages/rkwarddev/man/rk.XML.logic.Rd
@@ -13,8 +13,10 @@ rk.XML.logic(...)
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.
}
diff --git a/packages/rkwarddev/man/rk.XML.matrix.Rd b/packages/rkwarddev/man/rk.XML.matrix.Rd
index 6ee5268..58a8ca4 100644
--- a/packages/rkwarddev/man/rk.XML.matrix.Rd
+++ b/packages/rkwarddev/man/rk.XML.matrix.Rd
@@ -14,7 +14,8 @@ rk.XML.matrix(label, mode = "real", rows = 2, columns = 2, min = NULL,
\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}.}
@@ -34,17 +35,22 @@ largest representable value.}
\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, assume the column count will not change. The last (or typically only)
+\item{fixed_width}{Logical,
+ assume the column count will not change. The last (or typically only)
column will be stretched to take up the available width. Do not use in combination with matrices,
-where the number of columns may change in any way. Useful, esp. when creating a vector input element (rows="1").}
+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").}
@@ -55,16 +61,20 @@ Useful, esp. when creating a vector input element (columns="1").}
\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!}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.menu.Rd b/packages/rkwarddev/man/rk.XML.menu.Rd
index 6dd7512..a9725ea 100644
--- a/packages/rkwarddev/man/rk.XML.menu.Rd
+++ b/packages/rkwarddev/man/rk.XML.menu.Rd
@@ -14,16 +14,19 @@ rk.XML.menu(label, ..., index = -1, id.name = "auto", i18n = NULL)
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.}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.option.Rd b/packages/rkwarddev/man/rk.XML.option.Rd
index 62c54ce..41f7548 100644
--- a/packages/rkwarddev/man/rk.XML.option.Rd
+++ b/packages/rkwarddev/man/rk.XML.option.Rd
@@ -12,13 +12,16 @@ rk.XML.option(label, val = NULL, chk = FALSE, id.name = NULL,
\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.}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.optioncolumn.Rd b/packages/rkwarddev/man/rk.XML.optioncolumn.Rd
index a4756b6..4b4a0fc 100644
--- a/packages/rkwarddev/man/rk.XML.optioncolumn.Rd
+++ b/packages/rkwarddev/man/rk.XML.optioncolumn.Rd
@@ -8,25 +8,34 @@ rk.XML.optioncolumn(connect, modifier = NULL, label = TRUE,
external = FALSE, default = NULL, id.name = "auto", i18n = NULL)
}
\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.}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.optionset.Rd b/packages/rkwarddev/man/rk.XML.optionset.Rd
index 315d56a..27bcae3 100644
--- a/packages/rkwarddev/man/rk.XML.optionset.Rd
+++ b/packages/rkwarddev/man/rk.XML.optionset.Rd
@@ -13,22 +13,28 @@ rk.XML.optionset(content, optioncolumn, min_rows = 0, min_rows_if_any = 0,
\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.}
@@ -40,13 +46,16 @@ An object of class \code{XiMpLe.node}.
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
diff --git a/packages/rkwarddev/man/rk.XML.page.Rd b/packages/rkwarddev/man/rk.XML.page.Rd
index 2fc2a26..e7fe824 100644
--- a/packages/rkwarddev/man/rk.XML.page.Rd
+++ b/packages/rkwarddev/man/rk.XML.page.Rd
@@ -17,9 +17,12 @@ If \code{NULL}, no ID will be given.}
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
diff --git a/packages/rkwarddev/man/rk.XML.plugin.Rd b/packages/rkwarddev/man/rk.XML.plugin.Rd
index d8e59ee..c88b6e8 100644
--- a/packages/rkwarddev/man/rk.XML.plugin.Rd
+++ b/packages/rkwarddev/man/rk.XML.plugin.Rd
@@ -10,7 +10,8 @@ rk.XML.plugin(name, dialog = NULL, wizard = NULL, logic = NULL,
gen.info = TRUE, i18n = NULL)
}
\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
@@ -25,18 +26,24 @@ help files to be included, following the scheme \emph{"<name>.<ext>"}.}
\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>}
@@ -52,7 +59,8 @@ You can also provide a character string naming the very rkwarddev script file th
which will then also be added to the comment.}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.pluginmap.Rd b/packages/rkwarddev/man/rk.XML.pluginmap.Rd
index e6023f2..6e1c643 100644
--- a/packages/rkwarddev/man/rk.XML.pluginmap.Rd
+++ b/packages/rkwarddev/man/rk.XML.pluginmap.Rd
@@ -18,30 +18,39 @@ See \code{link[XiMpLe:rk.XML.about]{rk.XML.about}} for details. Skipped if \code
\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.
@@ -51,17 +60,22 @@ which will then also be added to the comment.}
\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...).
RKWard's internal plugins should use the namespace \code{rkward}. This is taken care of by \code{\link[rkwarddev:rk.plugin.skeleton]{rk.plugin.skeleton}}
if you set \code{internal=TRUE}.}
-\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{id.name}{Character string, a unique ID for this plugin element. If \code{"auto"}, an ID will be generated automatically from \code{name}.}
+\item{id.name}{Character string, a unique ID for this plugin element. If \code{"auto"},
+ an ID will be generated automatically from \code{name}.}
-\item{require.defaults}{Logical, if \code{TRUE}, \code{<require map="rkward::menu" />} and \code{<require map="rkward::embedded" />} will be added
-by default, which ensures that the menu structure and embeddable plugins are loaded. It shouldn't hurt to set this.}
+\item{require.defaults}{Logical, if \code{TRUE},
+ \code{<require map="rkward::menu" />} and \code{<require map="rkward::embedded" />} will be added
+by default,
+ which ensures that the menu structure and embeddable plugins are loaded. It shouldn't hurt to set this.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.preview.Rd b/packages/rkwarddev/man/rk.XML.preview.Rd
index 8759b9e..8522789 100644
--- a/packages/rkwarddev/man/rk.XML.preview.Rd
+++ b/packages/rkwarddev/man/rk.XML.preview.Rd
@@ -10,7 +10,8 @@ rk.XML.preview(label = "Preview", i18n = NULL)
\item{label}{A character string, text label for the preview checkbox.}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.radio.Rd b/packages/rkwarddev/man/rk.XML.radio.Rd
index 5446f7f..b34aa3f 100644
--- a/packages/rkwarddev/man/rk.XML.radio.Rd
+++ b/packages/rkwarddev/man/rk.XML.radio.Rd
@@ -12,23 +12,28 @@ rk.XML.radio(label, options = list(label = c(val = NULL, chk = FALSE, i18n =
\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. You might also provide an \code{i18n}
for this particular option (see \code{i18n}). 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
+\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!}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.require.Rd b/packages/rkwarddev/man/rk.XML.require.Rd
index 1542633..bef8b5c 100644
--- a/packages/rkwarddev/man/rk.XML.require.Rd
+++ b/packages/rkwarddev/man/rk.XML.require.Rd
@@ -7,10 +7,12 @@
rk.XML.require(file = NULL, map = NULL)
}
\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.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.saveobj.Rd b/packages/rkwarddev/man/rk.XML.saveobj.Rd
index 0000f80..2ce01c6 100644
--- a/packages/rkwarddev/man/rk.XML.saveobj.Rd
+++ b/packages/rkwarddev/man/rk.XML.saveobj.Rd
@@ -11,28 +11,35 @@ rk.XML.saveobj(label, chk = FALSE, checkable = TRUE, initial = "auto",
\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!}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.select.Rd b/packages/rkwarddev/man/rk.XML.select.Rd
index baf32a7..427240d 100644
--- a/packages/rkwarddev/man/rk.XML.select.Rd
+++ b/packages/rkwarddev/man/rk.XML.select.Rd
@@ -12,24 +12,30 @@ rk.XML.select(label, options = list(label = c(val = "", chk = FALSE, i18n =
\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. You might also provide an \code{i18n}
for this particular option (see \code{i18n}). 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!}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.set.Rd b/packages/rkwarddev/man/rk.XML.set.Rd
index 82f259c..ea190f8 100644
--- a/packages/rkwarddev/man/rk.XML.set.Rd
+++ b/packages/rkwarddev/man/rk.XML.set.Rd
@@ -14,7 +14,8 @@ or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and
\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{
diff --git a/packages/rkwarddev/man/rk.XML.snippets.Rd b/packages/rkwarddev/man/rk.XML.snippets.Rd
index 30e3c25..3af5db7 100644
--- a/packages/rkwarddev/man/rk.XML.snippets.Rd
+++ b/packages/rkwarddev/man/rk.XML.snippets.Rd
@@ -13,7 +13,8 @@ rk.XML.snippets(...)
An object of class \code{XiMpLe.node}.
}
\description{
-This function will create a snippets node for the document section, with optional child nodes
+This function will create a snippets node for the document section,
+ with optional child nodes
\code{<snippet>} and \code{<include>}.
}
\examples{
diff --git a/packages/rkwarddev/man/rk.XML.spinbox.Rd b/packages/rkwarddev/man/rk.XML.spinbox.Rd
index da21d03..a9d3d81 100644
--- a/packages/rkwarddev/man/rk.XML.spinbox.Rd
+++ b/packages/rkwarddev/man/rk.XML.spinbox.Rd
@@ -11,31 +11,40 @@ rk.XML.spinbox(label, min = NULL, max = NULL, initial = 0, real = TRUE,
\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!}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.switch.Rd b/packages/rkwarddev/man/rk.XML.switch.Rd
index 0a5b85b..15a611d 100644
--- a/packages/rkwarddev/man/rk.XML.switch.Rd
+++ b/packages/rkwarddev/man/rk.XML.switch.Rd
@@ -18,7 +18,8 @@ as you need, setting a return value for each \code{condition == case} respective
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.}
diff --git a/packages/rkwarddev/man/rk.XML.tabbook.Rd b/packages/rkwarddev/man/rk.XML.tabbook.Rd
index ee9a6cd..348a87b 100644
--- a/packages/rkwarddev/man/rk.XML.tabbook.Rd
+++ b/packages/rkwarddev/man/rk.XML.tabbook.Rd
@@ -18,7 +18,8 @@ If \code{"auto"}, IDs will be generated automatically from the labels.
If \code{NULL}, no IDs will be given.}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
@@ -28,7 +29,8 @@ An object of class \code{XiMpLe.node}.
Create XML node "tabbook" for RKWard plugins
}
\note{
-If a node in \code{tabs} is \code{<insert>}, it is returned as-is, without being nested in \code{<tab>}.
+If a node in \code{tabs} is \code{<insert>}, it is returned as-is,
+ without being nested in \code{<tab>}.
}
\examples{
test.checkboxes <- rk.XML.row(rk.XML.col(
diff --git a/packages/rkwarddev/man/rk.XML.values.Rd b/packages/rkwarddev/man/rk.XML.values.Rd
index 0aa9840..3ef4a51 100644
--- a/packages/rkwarddev/man/rk.XML.values.Rd
+++ b/packages/rkwarddev/man/rk.XML.values.Rd
@@ -16,7 +16,8 @@ rk.XML.values(label, slot.text, options = list(label = c(val = NULL, chk =
\item{slot.text}{Character string, a text label for the value selection slot.}
\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. You might also provide an \code{i18n}
for this particular option (see \code{i18n}). Objects generated with \code{\link[rkwarddev:rk.XML.option]{rk.XML.option}}
are accepted as well.}
@@ -25,7 +26,8 @@ are accepted as well.}
\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{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.}
@@ -42,16 +44,22 @@ if \code{FALSE} below it.}
\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!}
}
@@ -61,7 +69,8 @@ An object of class \code{XiMpLe.node}.
\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{
diff --git a/packages/rkwarddev/man/rk.XML.valueselector.Rd b/packages/rkwarddev/man/rk.XML.valueselector.Rd
index 24626a8..f8033e5 100644
--- a/packages/rkwarddev/man/rk.XML.valueselector.Rd
+++ b/packages/rkwarddev/man/rk.XML.valueselector.Rd
@@ -12,7 +12,8 @@ rk.XML.valueselector(label = NULL, options = list(label = c(val = NULL, chk
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. You might also provide an \code{i18n}
for this particular option (see \code{i18n}). Objects generated with \code{\link[rkwarddev:rk.XML.option]{rk.XML.option}}
are accepted as well.}
@@ -20,7 +21,8 @@ are accepted as well.}
\item{id.name}{Character vector, unique ID for this element.}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.valueslot.Rd b/packages/rkwarddev/man/rk.XML.valueslot.Rd
index 2998572..fd615a4 100644
--- a/packages/rkwarddev/man/rk.XML.valueslot.Rd
+++ b/packages/rkwarddev/man/rk.XML.valueslot.Rd
@@ -12,10 +12,12 @@ rk.XML.valueslot(label, source, property = NULL, required = FALSE,
\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} is not a
\code{<valueselector>} node.}
@@ -23,7 +25,8 @@ will cause the use of \code{source_property} instead of \code{source}. Only used
\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{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}.}
@@ -36,16 +39,20 @@ are selected at all. Sets \code{multi=TRUE}.}
\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!}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.vars.Rd b/packages/rkwarddev/man/rk.XML.vars.Rd
index 0673642..43182b7 100644
--- a/packages/rkwarddev/man/rk.XML.vars.Rd
+++ b/packages/rkwarddev/man/rk.XML.vars.Rd
@@ -20,7 +20,8 @@ rk.XML.vars(label, slot.text, required = FALSE, multi = FALSE,
\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{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.}
@@ -35,14 +36,19 @@ of dimensions is acceptable.}
\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,
@@ -52,26 +58,38 @@ if \code{FALSE} below it.}
\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!}
}
@@ -81,7 +99,8 @@ An object of class \code{XiMpLe.node}.
\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{
diff --git a/packages/rkwarddev/man/rk.XML.varselector.Rd b/packages/rkwarddev/man/rk.XML.varselector.Rd
index 91ab562..d7453c2 100644
--- a/packages/rkwarddev/man/rk.XML.varselector.Rd
+++ b/packages/rkwarddev/man/rk.XML.varselector.Rd
@@ -13,7 +13,8 @@ Must be set if \code{id.name="auto"}.}
\item{id.name}{Character vector, unique ID for this element.}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.varslot.Rd b/packages/rkwarddev/man/rk.XML.varslot.Rd
index 89e5ac1..ff0b26b 100644
--- a/packages/rkwarddev/man/rk.XML.varslot.Rd
+++ b/packages/rkwarddev/man/rk.XML.varslot.Rd
@@ -13,10 +13,12 @@ rk.XML.varslot(label, source, property = NULL, required = FALSE,
\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.}
@@ -24,7 +26,8 @@ will cause the use of \code{source_property} instead of \code{source}. Only used
\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{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}.}
@@ -39,29 +42,38 @@ of dimensions is acceptable.}
\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!}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.wizard.Rd b/packages/rkwarddev/man/rk.XML.wizard.Rd
index 90801f0..c83ad27 100644
--- a/packages/rkwarddev/man/rk.XML.wizard.Rd
+++ b/packages/rkwarddev/man/rk.XML.wizard.Rd
@@ -11,20 +11,24 @@ rk.XML.wizard(..., label = NULL, recommended = FALSE, i18n = NULL)
\item{label}{Character string, a text label for this plugin element.}
-\item{recommended}{Logical, whether the wizard should be the recommended interface (unless the user has configured
+\item{recommended}{Logical,
+ whether the wizard should be the recommended interface (unless the user has configured
RKWard to default to a specific interface).}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
-or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
}
\description{
-This function will create a wizard section with optional child nodes "browser", "checkbox",
+This function will create a wizard section with optional child nodes "browser",
+ "checkbox",
"column", "copy", "dropdown", "embed", "formula", "frame", "include", "input", "insert",
-"page", "preview", "radio", "row", "saveobject", "select", "spinbox", "stretch", "tabbook", "text",
+"page", "preview", "radio", "row", "saveobject", "select", "spinbox", "stretch",
+ "tabbook", "text",
"valueselector", "valueslot", "varselector" and "varslot".
}
\examples{
diff --git a/packages/rkwarddev/man/rk.build.plugin.Rd b/packages/rkwarddev/man/rk.build.plugin.Rd
index b3fd4ec..a71f351 100644
--- a/packages/rkwarddev/man/rk.build.plugin.Rd
+++ b/packages/rkwarddev/man/rk.build.plugin.Rd
@@ -7,15 +7,18 @@
rk.build.plugin(plugin, check = FALSE, install = FALSE, R.libs = NULL)
}
\arguments{
-\item{plugin}{A character string, path to the plugin package root directory (hint: it's the directory with
+\item{plugin}{A character string,
+ path to the plugin package root directory (hint: it's the directory with
the DESCRIPTION file in it).}
-\item{check}{Logical, whether the package should be checked for errors. Always do this before you
+\item{check}{Logical,
+ whether the package should be checked for errors. Always do this before you
publish a package!}
\item{install}{Logical, whether the built package should also be installed locally.}
-\item{R.libs}{A character string, path to local R packages, used by \code{install} to figure
+\item{R.libs}{A character string, path to local R packages,
+ used by \code{install} to figure
out where to install to.}
}
\description{
diff --git a/packages/rkwarddev/man/rk.get.rkh.prompter.Rd b/packages/rkwarddev/man/rk.get.rkh.prompter.Rd
index 5adb3f4..13dec38 100644
--- a/packages/rkwarddev/man/rk.get.rkh.prompter.Rd
+++ b/packages/rkwarddev/man/rk.get.rkh.prompter.Rd
@@ -7,11 +7,14 @@
rk.get.rkh.prompter(component = NULL, id = NULL)
}
\arguments{
-\item{component}{Character string, the name under which you stored information. If \code{NULL},
+\item{component}{Character string,
+ the name under which you stored information. If \code{NULL},
returns all information stored in the internal \code{rkh.prompter} list.}
-\item{id}{Character string, the node ID if a given component to search for. If \code{NULL}, returns
-the full list of the given component, otherwise only the help information for the requested node.}
+\item{id}{Character string,
+ the node ID if a given component to search for. If \code{NULL}, returns
+the full list of the given component,
+ otherwise only the help information for the requested node.}
}
\description{
Get .rkh related information stored internally
diff --git a/packages/rkwarddev/man/rk.local.Rd b/packages/rkwarddev/man/rk.local.Rd
index c51f85f..aed7b10 100644
--- a/packages/rkwarddev/man/rk.local.Rd
+++ b/packages/rkwarddev/man/rk.local.Rd
@@ -13,9 +13,11 @@ rk.local(...)
The result of evaluating the object(s).
}
\description{
-Can be used like \code{\link[base:local]{local}}, but evaluation is being done in a speacial
+Can be used like \code{\link[base:local]{local}},
+ but evaluation is being done in a speacial
local environment of the rkwarddev package. This can be neccessary if you want to call functions
-nested insinde \code{\link[rkwarddev:js]{js}}, because it might not find all objects if they were
+nested insinde \code{\link[rkwarddev:js]{js}},
+ because it might not find all objects if they were
only defined in a standard local environment.
}
diff --git a/packages/rkwarddev/man/rk.paste.JS.Rd b/packages/rkwarddev/man/rk.paste.JS.Rd
index 5d84737..bd3cf81 100644
--- a/packages/rkwarddev/man/rk.paste.JS.Rd
+++ b/packages/rkwarddev/man/rk.paste.JS.Rd
@@ -10,7 +10,8 @@ rk.paste.JS(..., level = 2, indent.by = rk.get.indent(), funct = NULL,
opt.sep = NULL)
}
\arguments{
-\item{...}{Objects of class \code{rk.JS.ite}, \code{rk.JS.arr}, \code{rk.JS.opt}, \code{rk.JS.oset} or character.
+\item{...}{Objects of class \code{rk.JS.ite}, \code{rk.JS.arr}, \code{rk.JS.opt},
+ \code{rk.JS.oset} or character.
Another special case is XiMpLe nodes created by \code{rk.comment()}, which will be turned
into JavaScript comments (i.e., lines starting with "//").}
@@ -18,10 +19,13 @@ into JavaScript comments (i.e., lines starting with "//").}
\item{indent.by}{A character string defining the indentation string to use.}
-\item{funct}{For \code{rk.JS.arr} and \code{rk.JS.opt} objects only: 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{funct}{For \code{rk.JS.arr} and \code{rk.JS.opt} objects only: 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{array}{For \code{rk.JS.opt} objects only: Logical, whether the options should be collected
+\item{array}{For \code{rk.JS.opt} objects only: Logical,
+ whether the options should be collected
in an array or a concatenated character string.}
\item{var.prefix}{For \code{rk.JS.var} objects only: A character string. will be used as a prefix
@@ -29,24 +33,34 @@ for the JS variable names.}
\item{modifiers}{For \code{rk.JS.var} objects only: A character vector with modifiers you'd like to apply the XML node's property.}
-\item{default}{For \code{rk.JS.var} objects only: Logical, if \code{TRUE} the default value (no special modifier) of the node will
+\item{default}{For \code{rk.JS.var} objects only: 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}{For \code{rk.JS.var} objects only: 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
+\item{join}{For \code{rk.JS.var} objects only: 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{getter}{For \code{rk.JS.var} objects only: 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}{For \code{rk.JS.var} objects only: 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{var}{For \code{rk.JS.var} objects only: Logical, if \code{FALSE} the variable(s) are assumed to already be defined (globally?)
+\item{var}{For \code{rk.JS.var} objects only: Logical,
+ if \code{FALSE} the variable(s) are assumed to already be defined (globally?)
and the JS keyword "var" will be omitted.}
-\item{empty.e}{For \code{rk.JS.ite} objects only: Logical, if \code{TRUE} will force to add empty \code{else \{\}} brackets when
-there is no \code{else} statement defined, which is considered to enhance code readability by some.}
+\item{empty.e}{For \code{rk.JS.ite} objects only: Logical,
+ if \code{TRUE} will force to add empty \code{else \{\}} brackets when
+there is no \code{else} statement defined,
+ which is considered to enhance code readability by some.}
-\item{opt.sep}{For \code{rk.JS.arr} and \code{rk.JS.opt} objects only: Character string, will be printed in the resulting R code
+\item{opt.sep}{For \code{rk.JS.arr} and \code{rk.JS.opt} objects only: Character string,
+ will be printed in the resulting R code
before the option name.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.paste.JS.graph.Rd b/packages/rkwarddev/man/rk.paste.JS.graph.Rd
index bb6c23f..ee3eb20 100644
--- a/packages/rkwarddev/man/rk.paste.JS.graph.Rd
+++ b/packages/rkwarddev/man/rk.paste.JS.graph.Rd
@@ -10,7 +10,8 @@ rk.paste.JS.graph(..., plotOpts = NULL, printoutObj = NULL, level = 2,
\arguments{
\item{...}{The actual plot code, passed through to \code{rk.paste.JS}.}
-\item{plotOpts}{An object generated by \code{rk.XML.embed} or \code{rk.plotOptions}, i.e. embedded plot options.}
+\item{plotOpts}{An object generated by \code{rk.XML.embed} or \code{rk.plotOptions},
+ i.e. embedded plot options.}
\item{printoutObj}{An \code{rk.JS.var} object fetching the \code{"code.printout"} modifier of \code{plotOpts}
(see examples below!). If \code{NULL} and \code{plotOpts} is of class \code{rk.plot.opts} (as returned by \code{rk.plotOptions}),
@@ -20,21 +21,26 @@ will be fetched from \code{plotOpts} automatically.}
\item{indent.by}{A character string defining the indentation string to use.}
-\item{empty.e}{For \code{rk.JS.ite} objects only: Logical, if \code{TRUE} will force to add empty \code{else \{\}} brackets when
-there is no \code{else} statement defined, which is considered to enhance code readability by some.}
+\item{empty.e}{For \code{rk.JS.ite} objects only: Logical,
+ if \code{TRUE} will force to add empty \code{else \{\}} brackets when
+there is no \code{else} statement defined,
+ which is considered to enhance code readability by some.}
}
\value{
A character string.
}
\description{
-This function is similar to \code{rk.paste.JS}, but adds some code parts to its output which
+This function is similar to \code{rk.paste.JS},
+ but adds some code parts to its output which
are commonly used to generate plots with RKWard.
}
\details{
The contents of the \code{...} argument are evaluated by \code{rk.paste.JS} and encapsulated
between \code{if(full)\{rk.graph.on()\} try(\{} and \code{\}) if(full)\{rk.graph.off()\}}. If generic
-plot options are supplied, their \code{"code.preprocess"} and \code{"code.calculate"} modifiers are
-also automatically taken care of, so you only need to include \code{"code.printout"} inside of
+plot options are supplied,
+ their \code{"code.preprocess"} and \code{"code.calculate"} modifiers are
+also automatically taken care of,
+ so you only need to include \code{"code.printout"} inside of
\code{...}.
}
\examples{
diff --git a/packages/rkwarddev/man/rk.plotOptions.Rd b/packages/rkwarddev/man/rk.plotOptions.Rd
index 6a4c6f8..bcc8684 100644
--- a/packages/rkwarddev/man/rk.plotOptions.Rd
+++ b/packages/rkwarddev/man/rk.plotOptions.Rd
@@ -8,21 +8,26 @@ rk.plotOptions(label = "Generic plot options",
embed = "rkward::plot_options", button = TRUE, id.name = "auto")
}
\arguments{
-\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{embed}{A character string, registered name (\code{id} in pluginmap file) of the plot options component to be embedded.}
+\item{embed}{A character string,
+ registered name (\code{id} in pluginmap file) of the plot options component to be embedded.}
-\item{button}{Logical, whether the plot options should be embedded as a button and appear if it's pressed.}
+\item{button}{Logical,
+ whether the plot options should be embedded as a button and appear if it's pressed.}
\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{rk.plot.opts}.
}
\description{
Generates XML and JavaScript code snippets by calling \code{rk.XML.embed} and \code{rk.JS.vars} with useful presets. The
-resulting object can be used inside the dialog XML object (to place the plot options button and disable certain tabs), as
+resulting object can be used inside the dialog XML object (to place the plot options button and disable certain tabs),
+ as
well as in the JS object (to then insert the actual plot options).
}
\examples{
diff --git a/packages/rkwarddev/man/rk.plugin.component.Rd b/packages/rkwarddev/man/rk.plugin.component.Rd
index 1d5668d..ffd16d0 100644
--- a/packages/rkwarddev/man/rk.plugin.component.Rd
+++ b/packages/rkwarddev/man/rk.plugin.component.Rd
@@ -11,51 +11,73 @@ rk.plugin.component(about, xml = list(), js = list(), rkh = list(),
gen.info = TRUE, indent.by = rk.get.indent())
}
\arguments{
-\item{about}{Either a character string with the name of this plugin component, or an object of class \code{XiMpLe.node}
-with further descriptive information on it, like its authors and dependencies (see \code{link[XiMpLe:rk.XML.about]{rk.XML.about}}
+\item{about}{Either a character string with the name of this plugin component,
+ or an object of class \code{XiMpLe.node}
+with further descriptive information on it,
+ like its authors and dependencies (see \code{link[XiMpLe:rk.XML.about]{rk.XML.about}}
for details). This is only useful for information that differs from the \code{<about>} section of the \code{.pluginmap} file.}
-\item{xml}{A named list of options to be forwarded to \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}}, to generate the GUI XML file.
+\item{xml}{A named list of options to be forwarded to \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}},
+ to generate the GUI XML file.
Not all options are supported because some don't make sense in this context. Valid options are:
\code{"dialog"}, \code{"wizard"}, \code{"logic"} and \code{"snippets"}.
-If not set, their default values are used. See \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}} for details.}
+If not set,
+ their default values are used. See \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}} for details.}
-\item{js}{A named list of options to be forwarded to \code{\link[rkwarddev:rk.JS.doc]{rk.JS.doc}}, to generate the JavaScript file.
+\item{js}{A named list of options to be forwarded to \code{\link[rkwarddev:rk.JS.doc]{rk.JS.doc}},
+ to generate the JavaScript file.
Not all options are supported because some don't make sense in this context. Valid options are:
-\code{"require"}, \code{"results.header"}, \code{"header.add"}, \code{"variables"}, \code{"globals"}, \code{"preprocess"},
+\code{"require"}, \code{"results.header"}, \code{"header.add"}, \code{"variables"},
+ \code{"globals"}, \code{"preprocess"},
\code{"calculate"}, \code{"printout"}, \code{"doPrintout"} and \code{"load.silencer"}.
-If not set, their default values are used. See \code{\link[rkwarddev:rk.JS.doc]{rk.JS.doc}} for details.}
+If not set,
+ their default values are used. See \code{\link[rkwarddev:rk.JS.doc]{rk.JS.doc}} for details.}
-\item{rkh}{A named list of options to be forwarded to \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}}, to generate the help file.
+\item{rkh}{A named list of options to be forwarded to \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}},
+ to generate the help file.
Not all options are supported because some don't make sense in this context. Valid options are:
-\code{"summary"}, \code{"usage"}, \code{"sections"}, \code{"settings"}, \code{"related"} and \code{"technical"}.
-If not set, their default values are used. See \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}} for details.}
+\code{"summary"}, \code{"usage"}, \code{"sections"}, \code{"settings"},
+ \code{"related"} and \code{"technical"}.
+If not set,
+ their default values are used. See \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}} for details.}
-\item{provides}{Character vector with possible entries of \code{"logic"}, \code{"dialog"} or \code{"wizard"}, defining what
-sections the GUI XML file 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 GUI XML file 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{scan}{A character vector to trigger various automatic scans of the generated GUI XML file. Valid enties are:
\describe{
\item{\code{"var"}}{Calls \code{\link{rk.JS.scan}} to define all needed variables in the \code{calculate()} function
- of the JavaScript file. These variables will be added to variables defined by the \code{js} option, if any (see below).}
+ of the JavaScript file. These variables will be added to variables defined by the \code{js} option,
+ if any (see below).}
\item{\code{"saveobj"}}{Calls \code{\link{rk.JS.saveobj}} to generate code to save R results in the \code{printout()}
- function of the JavaScript file. This code will be added to the code defined by the \code{js} option, if any (see below).}
+ function of the JavaScript file. This code will be added to the code defined by the \code{js} option,
+ if any (see below).}
\item{\code{"settings"}}{Calls \code{\link{rk.rkh.scan}} to generate \code{<setting>} sections for each relevant GUI element in
the \code{<settings>} section of the help file. This option will be overruled if you provide that section manually
by the \code{rkh} option (see below).}
}}
-\item{guess.getter}{Logical, if \code{TRUE} try to get a good default getter function for JavaScript
-variable values (if \code{scan} is active). 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 (if \code{scan} is active). 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{hierarchy}{A character vector with instructions where to place this component in the menu hierarchy, one list or string.
-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.}
+\item{hierarchy}{A character vector with instructions where to place this component in the menu hierarchy,
+ one list or string.
+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.}
-\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{create}{A character vector with one or more of these possible entries:
\describe{
@@ -68,9 +90,11 @@ anything else will place it in a "test" menu. If \code{hierarchy} is a list, eac
See \code{\link[rkwarddev:rk.XML.dependencies]{rk.XML.dependencies}} for details. Skipped if \code{NULL}.
This is only useful for information that differs from the \code{<dependencies>} section of the \code{.pluginmap} file.}
-\item{hints}{Logical, if \code{TRUE} and you leave optional entries empty (like \code{rkh=list()}), dummy sections will be added.}
+\item{hints}{Logical,
+ if \code{TRUE} and you leave optional entries empty (like \code{rkh=list()}), dummy sections will be added.}
-\item{gen.info}{Logical, if \code{TRUE} comment notes will be written into the genrated documents,
+\item{gen.info}{Logical,
+ if \code{TRUE} comment notes will be written into the genrated documents,
that they were generated by \code{rkwarddev} and changes should be done to the script.
You can also provide a character string naming the very rkwarddev script file that generates this component,
which will then also be added to the comment.}
diff --git a/packages/rkwarddev/man/rk.plugin.skeleton.Rd b/packages/rkwarddev/man/rk.plugin.skeleton.Rd
index e853e4a..a404e14 100644
--- a/packages/rkwarddev/man/rk.plugin.skeleton.Rd
+++ b/packages/rkwarddev/man/rk.plugin.skeleton.Rd
@@ -15,58 +15,80 @@ rk.plugin.skeleton(about, path = tempdir(), provides = c("logic", "dialog"),
}
\arguments{
\item{about}{Either 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), or a character string with the name of the plugin package.
+(see \code{link[XiMpLe:rk.XML.about]{rk.XML.about}} for details),
+ or a character string with the name of the plugin package.
If the latter, no \code{DESCRIPTION} file will be created.}
-\item{path}{Character sting, path to the main directory where the skeleton should be created.}
+\item{path}{Character sting,
+ path to the main directory where the skeleton should be created.}
-\item{provides}{Character vector with possible entries of \code{"logic"}, \code{"dialog"} or \code{"wizard"}, defining what
-sections the GUI XML file 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 GUI XML file 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{scan}{A character vector to trigger various automatic scans of the generated GUI XML file. Valid enties are:
\describe{
\item{\code{"var"}}{Calls \code{\link{rk.JS.scan}} to define all needed variables in the \code{calculate()} function
- of the JavaScript file. These variables will be added to variables defined by the \code{js} option, if any (see below).}
+ of the JavaScript file. These variables will be added to variables defined by the \code{js} option,
+ if any (see below).}
\item{\code{"saveobj"}}{Calls \code{\link{rk.JS.saveobj}} to generate code to save R results in the \code{printout()}
- function of the JavaScript file. This code will be added to the code defined by the \code{js} option, if any (see below).}
+ function of the JavaScript file. This code will be added to the code defined by the \code{js} option,
+ if any (see below).}
\item{\code{"settings"}}{Calls \code{\link{rk.rkh.scan}} to generate \code{<setting>} sections for each relevant GUI element in
the \code{<settings>} section of the help file. This option will be overruled if you provide that section manually
by the \code{rkh} option (see below).}
}}
-\item{guess.getter}{Logical, if \code{TRUE} try to get a good default getter function for JavaScript
-variable values (if \code{scan} is active). 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 (if \code{scan} is active). 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{xml}{A named list of options to be forwarded to \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}}, to generate the GUI XML file.
+\item{xml}{A named list of options to be forwarded to \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}},
+ to generate the GUI XML file.
Not all options are supported because some don't make sense in this context. Valid options are:
\code{"dialog"}, \code{"wizard"}, \code{"logic"} and \code{"snippets"}.
-If not set, their default values are used. See \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}} for details.}
+If not set,
+ their default values are used. See \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}} for details.}
-\item{js}{A named list of options to be forwarded to \code{\link[rkwarddev:rk.JS.doc]{rk.JS.doc}}, to generate the JavaScript file.
+\item{js}{A named list of options to be forwarded to \code{\link[rkwarddev:rk.JS.doc]{rk.JS.doc}},
+ to generate the JavaScript file.
Not all options are supported because some don't make sense in this context. Valid options are:
-\code{"require"}, \code{"results.header"}, \code{"header.add"}, \code{"variables"}, \code{"globals"}, \code{"preprocess"},
+\code{"require"}, \code{"results.header"}, \code{"header.add"}, \code{"variables"},
+ \code{"globals"}, \code{"preprocess"},
\code{"calculate"}, \code{"printout"}, \code{"doPrintout"} and \code{"load.silencer"}.
-If not set, their default values are used. See \code{\link[rkwarddev:rk.JS.doc]{rk.JS.doc}} for details.}
+If not set,
+ their default values are used. See \code{\link[rkwarddev:rk.JS.doc]{rk.JS.doc}} for details.}
-\item{pluginmap}{A named list of options to be forwarded to \code{\link[rkwarddev:rk.XML.pluginmap]{rk.XML.pluginmap}}, to generate the pluginmap file.
+\item{pluginmap}{A named list of options to be forwarded to \code{\link[rkwarddev:rk.XML.pluginmap]{rk.XML.pluginmap}},
+ to generate the pluginmap file.
Not all options are supported because some don't make sense in this context. Valid options are:
-\code{"name"}, \code{"namespace"} (see also \code{internal}), \code{"hierarchy"} and \code{"require"}.
-If not set, their default values are used. See \code{\link[rkwarddev:rk.XML.pluginmap]{rk.XML.pluginmap}} for details.}
+\code{"name"}, \code{"namespace"} (see also \code{internal}),
+ \code{"hierarchy"} and \code{"require"}.
+If not set,
+ their default values are used. See \code{\link[rkwarddev:rk.XML.pluginmap]{rk.XML.pluginmap}} for details.}
-\item{rkh}{A named list of options to be forwarded to \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}}, to generate the help file.
+\item{rkh}{A named list of options to be forwarded to \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}},
+ to generate the help file.
Not all options are supported because some don't make sense in this context. Valid options are:
-\code{"summary"}, \code{"usage"}, \code{"sections"}, \code{"settings"}, \code{"related"} and \code{"technical"}.
-If not set, their default values are used. See \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}} for details.}
+\code{"summary"}, \code{"usage"}, \code{"sections"}, \code{"settings"},
+ \code{"related"} and \code{"technical"}.
+If not set,
+ their default values are used. See \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}} for details.}
-\item{overwrite}{Logical, whether existing files should be replaced. Defaults to \code{FALSE}.}
+\item{overwrite}{Logical,
+ whether existing files should be replaced. Defaults to \code{FALSE}.}
\item{tests}{Logical, whether directories and files for plugin tests should be created.
Defaults to \code{TRUE}. A new testsuite file will only be generated if none is present
(\code{overwrite} is ignored).}
-\item{lazyLoad}{Logical, whether the package should be prepared for lazy loading or not. Should be left \code{TRUE},
+\item{lazyLoad}{Logical,
+ whether the package should be prepared for lazy loading or not. Should be left \code{TRUE},
unless you have very good reasons not to.}
\item{create}{A character vector with one or more of these possible entries:
@@ -80,7 +102,8 @@ unless you have very good reasons not to.}
}
Default is to create all of these files. Existing files will only be overwritten if \code{overwrite=TRUE}.}
-\item{suggest.required}{Logical, if \code{TRUE} R package dependencies in \code{about} will be added to the \code{Suggests:}
+\item{suggest.required}{Logical,
+ if \code{TRUE} R package dependencies in \code{about} will be added to the \code{Suggests:}
field of the \code{DESCRIPTION} file, otherwise to the \code{Depends:} field.}
\item{components}{A list of plugin components. See \code{\link[rkwarddev:rk.XML.component]{rk.XML.component}} for details.}
@@ -88,25 +111,32 @@ field of the \code{DESCRIPTION} file, otherwise to the \code{Depends:} field.}
\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{edit}{Logical, if \code{TRUE} RKWard will automatically open the created files for editing, by calling \code{rk.edit.files}.
+\item{edit}{Logical,
+ if \code{TRUE} RKWard will automatically open the created files for editing, by calling \code{rk.edit.files}.
This applies to all files defined in \code{create}.}
-\item{load}{Logical, if \code{TRUE} and \code{"pmap"} in \code{create}, RKWard will automatically add the created .pluginmap file
+\item{load}{Logical, if \code{TRUE} and \code{"pmap"} in \code{create},
+ RKWard will automatically add the created .pluginmap file
to its menu structure by calling \code{rk.load.pluginmaps}. You can then try the plugin immediately.}
-\item{show}{Logical, if \code{TRUE} and \code{"pmap"} in \code{create}, RKWard will automatically call the created plugin after
-it was loaded (i.e., this implies and also sets \code{load=TRUE}). This will only work on the main component, though.}
+\item{show}{Logical, if \code{TRUE} and \code{"pmap"} in \code{create},
+ RKWard will automatically call the created plugin after
+it was loaded (i.e.,
+ this implies and also sets \code{load=TRUE}). This will only work on the main component, though.}
-\item{gen.info}{Logical, if \code{TRUE} comment notes will be written into the genrated documents,
+\item{gen.info}{Logical,
+ if \code{TRUE} comment notes will be written into the genrated documents,
that they were generated by \code{rkwarddev} and changes should be done to the script.
You can also provide a character string naming the very rkwarddev script file that generates this plugin and its main component,
which will then also be added to the comment.}
-\item{hints}{Logical, if \code{TRUE} and you leave out optional entries (like \code{dependencies=NULL}), dummy sections will be added as comments.}
+\item{hints}{Logical,
+ if \code{TRUE} and you leave out optional entries (like \code{dependencies=NULL}), dummy sections will be added as comments.}
\item{indent.by}{A character string defining the indentation string to use.}
-\item{internal}{Logical, a simple switch to build an internal plugin for official distribution with RKWard. If set to \code{TRUE}:
+\item{internal}{Logical,
+ a simple switch to build an internal plugin for official distribution with RKWard. If set to \code{TRUE}:
\itemize{
\item{The plugin will have its namespace set to \code{"rkward"}.}
\item{The \code{<about>} info will also be available in the main component.}
@@ -118,8 +148,10 @@ which will then also be added to the comment.}
Character string with the path to the plugin root directory.
}
\description{
-With this function you can write everything from a basic skeleton structure to a complete functional plugin, including several
-components/dialogs. You should always define one main component (by \code{xml}, \code{js}, \code{rkh} etc.) before you provide
+With this function you can write everything from a basic skeleton structure to a complete functional plugin,
+ including several
+components/dialogs. You should always define one main component (by \code{xml}, \code{js},
+ \code{rkh} etc.) before you provide
additional features by \code{components}.
}
\examples{
diff --git a/packages/rkwarddev/man/rk.rkh.doc.Rd b/packages/rkwarddev/man/rk.rkh.doc.Rd
index 9879897..b8eed29 100644
--- a/packages/rkwarddev/man/rk.rkh.doc.Rd
+++ b/packages/rkwarddev/man/rk.rkh.doc.Rd
@@ -31,7 +31,8 @@ Refer to \code{\link{rk.rkh.scan}} for a function to create this from an existin
\item{title}{An object of class \code{XiMpLe.node} to be pasted as the \code{<title>} section. See
\code{\link[rkwarddev:rk.rkh.title]{rk.rkh.title}} for details.}
-\item{hints}{Logical, if \code{TRUE} and you leave out optional entries (like \code{technical=NULL}), empty dummy sections will be added.}
+\item{hints}{Logical,
+ if \code{TRUE} and you leave out optional entries (like \code{technical=NULL}), empty dummy sections will be added.}
\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.
diff --git a/packages/rkwarddev/man/rk.rkh.scan.Rd b/packages/rkwarddev/man/rk.rkh.scan.Rd
index ae045ca..e654f15 100644
--- a/packages/rkwarddev/man/rk.rkh.scan.Rd
+++ b/packages/rkwarddev/man/rk.rkh.scan.Rd
@@ -7,14 +7,18 @@
rk.rkh.scan(pXML, help = TRUE, captions = TRUE, component = NULL)
}
\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{help}{Logical, if \code{TRUE} a list of XiMpLe.node objects will be returned, otherwise a character
+\item{help}{Logical, if \code{TRUE} a list of XiMpLe.node objects will be returned,
+ otherwise a character
vector with only the relevant ID names.}
-\item{captions}{Logical, if \code{TRUE} captions will be generated for all "page", "tab" and "frame" nodes.}
+\item{captions}{Logical, if \code{TRUE} captions will be generated for all "page",
+ "tab" and "frame" nodes.}
-\item{component}{Character string, name of the scanned component. Only needed if you want to search for
+\item{component}{Character string,
+ name of the scanned component. Only needed if you want to search for
help text provided by \code{\link[rkwarddev:rk.set.rkh.prompter]{rk.set.rkh.prompter}}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.rkh.section.Rd b/packages/rkwarddev/man/rk.rkh.section.Rd
index 4456ae6..33301c0 100644
--- a/packages/rkwarddev/man/rk.rkh.section.Rd
+++ b/packages/rkwarddev/man/rk.rkh.section.Rd
@@ -19,7 +19,8 @@ If \code{"auto"}, an ID will be generated automatically from the \code{title} va
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
or \code{comment}, to give some \code{i18n_context} information for this node.
-If set to \code{FALSE}, the attribute \code{title} will be renamed into \code{noi18n_title}.}
+If set to \code{FALSE},
+ the attribute \code{title} will be renamed into \code{noi18n_title}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.rkh.setting.Rd b/packages/rkwarddev/man/rk.rkh.setting.Rd
index aed8dd7..0d70853 100644
--- a/packages/rkwarddev/man/rk.rkh.setting.Rd
+++ b/packages/rkwarddev/man/rk.rkh.setting.Rd
@@ -17,7 +17,8 @@ of the element will be shown.}
\item{i18n}{Either a character string or a named list with the optional elements \code{context}
or \code{comment}, to give some \code{i18n_context} information for this node.
-If set to \code{FALSE}, the attribute \code{title} will be renamed into \code{noi18n_title}.}
+If set to \code{FALSE},
+ the attribute \code{title} will be renamed into \code{noi18n_title}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.rkh.settings.Rd b/packages/rkwarddev/man/rk.rkh.settings.Rd
index 3d9ba9c..abcde2c 100644
--- a/packages/rkwarddev/man/rk.rkh.settings.Rd
+++ b/packages/rkwarddev/man/rk.rkh.settings.Rd
@@ -13,7 +13,8 @@ rk.rkh.settings(...)
An object of class \code{XiMpLe.node}.
}
\description{
-This function will create a settings node for the document section, with optional child nodes "setting" and "caption".
+This function will create a settings node for the document section,
+ with optional child nodes "setting" and "caption".
}
\examples{
# define a sample frame
diff --git a/packages/rkwarddev/man/rk.set.comp.Rd b/packages/rkwarddev/man/rk.set.comp.Rd
index a1bdb11..0644663 100644
--- a/packages/rkwarddev/man/rk.set.comp.Rd
+++ b/packages/rkwarddev/man/rk.set.comp.Rd
@@ -14,7 +14,8 @@ subsequently.}
\description{
This small tool let's you set a component name as kind of "active", which simply
means it will be returned by \code{\link[rkwarddev:rk.get.comp]{rk.get.comp}}. This can be
-used by functions like, e.g., \code{\link[rkwarddev:rk.XML.cbox]{rk.XML.cbox}}, to add text
+used by functions like, e.g., \code{\link[rkwarddev:rk.XML.cbox]{rk.XML.cbox}},
+ to add text
for .rkh pages automatically to the current plugin component.
}
diff --git a/packages/rkwarddev/man/rk.set.empty.e.Rd b/packages/rkwarddev/man/rk.set.empty.e.Rd
index 800b5ed..bb61360 100644
--- a/packages/rkwarddev/man/rk.set.empty.e.Rd
+++ b/packages/rkwarddev/man/rk.set.empty.e.Rd
@@ -13,7 +13,8 @@ rk.set.empty.e(empty = FALSE)
\item{empty}{Logical, whether .}
}
\value{
-\code{rk.set.empty.e} returns invisible(NULL), \code{rk.get.empty.e} either \code{TRUE} or \code{FALSE}.
+\code{rk.set.empty.e} returns invisible(NULL),
+ \code{rk.get.empty.e} either \code{TRUE} or \code{FALSE}.
}
\description{
Some JS functions allow to decide whether empty \code{else} statements should be omitted or printed
diff --git a/packages/rkwarddev/man/rk.set.indent.Rd b/packages/rkwarddev/man/rk.set.indent.Rd
index 430a263..eb772dd 100644
--- a/packages/rkwarddev/man/rk.set.indent.Rd
+++ b/packages/rkwarddev/man/rk.set.indent.Rd
@@ -10,7 +10,8 @@ rk.get.indent(escape = FALSE)
rk.set.indent(by = "\\t")
}
\arguments{
-\item{escape}{Logical, if set to \code{TRUE} each occurring "\\t" will be escaped by an additional "\\".}
+\item{escape}{Logical,
+ if set to \code{TRUE} each occurring "\\t" will be escaped by an additional "\\".}
\item{by}{Character string, indentation string to be defined globally.}
}
diff --git a/packages/rkwarddev/man/rk.set.rkh.prompter.Rd b/packages/rkwarddev/man/rk.set.rkh.prompter.Rd
index cd221c0..d4a6546 100644
--- a/packages/rkwarddev/man/rk.set.rkh.prompter.Rd
+++ b/packages/rkwarddev/man/rk.set.rkh.prompter.Rd
@@ -8,27 +8,33 @@ rk.set.rkh.prompter(component = NULL, id = NULL, help = NULL,
rm = FALSE)
}
\arguments{
-\item{component}{Character string, should be a unique name to identify the current plugin/component.
+\item{component}{Character string,
+ should be a unique name to identify the current plugin/component.
If \code{NULL}, this function quits silently without any action.}
\item{id}{Either a character string (the \code{id} of the node to store the help information for),
or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used).}
-\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.}
-\item{rm}{Logical, If \code{TRUE} will remove all information stored by the name of \code{component} (if
+\item{rm}{Logical,
+ If \code{TRUE} will remove all information stored by the name of \code{component} (if
\code{id=NULL}) or of the given \code{id=NULL}, respectively.}
}
\description{
By using an environment like this, you are able to write information for RKWard help files
-directly into your script code of certrain functions, like for radio buttons or checkboxes.
+directly into your script code of certrain functions,
+ like for radio buttons or checkboxes.
}
\details{
-The information is temporarily stored in an internal environment, using the plugin/component name
+The information is temporarily stored in an internal environment,
+ using the plugin/component name
you specify. Each entry is named after the ID of its respective node. If you later call
\code{\link[rkwarddev:rk.plugin.component]{rk.plugin.component}} (or it is called by other
functions) and you activate the \code{scan} option for rkh files, the scanning process
-will try to find a match for each relevant XML node. That is, the info which is stored in the
+will try to find a match for each relevant XML node. That is,
+ the info which is stored in the
environment will magically be written into the help file.
}
\examples{
diff --git a/packages/rkwarddev/man/rk.updatePluginMessages.Rd b/packages/rkwarddev/man/rk.updatePluginMessages.Rd
index 51221aa..3067a7c 100644
--- a/packages/rkwarddev/man/rk.updatePluginMessages.Rd
+++ b/packages/rkwarddev/man/rk.updatePluginMessages.Rd
@@ -8,9 +8,11 @@ rk.updatePluginMessages(pluginmap, extractOnly = FALSE, default_po = NULL,
outdir = NULL)
}
\arguments{
-\item{pluginmap}{Character string, full path to the main pluginmap file of the plugin to translate.}
+\item{pluginmap}{Character string,
+ full path to the main pluginmap file of the plugin to translate.}
-\item{extractOnly}{Logical, should translatable strings only be extracted? If \code{FALSE}, translatable
+\item{extractOnly}{Logical,
+ should translatable strings only be extracted? If \code{FALSE}, translatable
strings will be updated and installed.}
\item{default_po}{Optional character string, fallback default name for \code{*.pot} file.}
diff --git a/packages/rkwarddev/man/rkwarddev-package.Rd b/packages/rkwarddev/man/rkwarddev-package.Rd
index 389b2fe..7ed2273 100644
--- a/packages/rkwarddev/man/rkwarddev-package.Rd
+++ b/packages/rkwarddev/man/rkwarddev-package.Rd
@@ -12,7 +12,7 @@ A Collection of Tools for RKWard Plugin Development.
Package: \tab rkwarddev\cr
Type: \tab Package\cr
Version: \tab 0.08-1\cr
-Date: \tab 2015-11-28\cr
+Date: \tab 2015-11-30\cr
Depends: \tab R (>= 2.9.0),methods,XiMpLe (>= 0.03-21),rkward (>= 0.5.7)\cr
Enhances: \tab rkward\cr
Encoding: \tab UTF-8\cr
diff --git a/packages/rkwarddev/man/rkwarddev.required.Rd b/packages/rkwarddev/man/rkwarddev.required.Rd
index 1829863..a5b3a51 100644
--- a/packages/rkwarddev/man/rkwarddev.required.Rd
+++ b/packages/rkwarddev/man/rkwarddev.required.Rd
@@ -12,7 +12,8 @@ rkwarddev.required(min = "0.06-5", lib.loc = NULL)
\item{lib.loc}{The \code{lib.loc} argument passed over to \code{\link[utils:packageVersion]{packageVersion}}.}
}
\value{
-The function has no return value, but wil stop with an error if the specified version requirement is not met.
+The function has no return value,
+ but wil stop with an error if the specified version requirement is not met.
}
\description{
Check for rkwarddev package version requirements
diff --git a/packages/rkwarddev/man/tf.Rd b/packages/rkwarddev/man/tf.Rd
index ae3aa2e..29a6b99 100644
--- a/packages/rkwarddev/man/tf.Rd
+++ b/packages/rkwarddev/man/tf.Rd
@@ -8,27 +8,38 @@ tf(cbox, true = TRUE, not = FALSE, ifelse = FALSE, false = FALSE,
opt = NULL, prefix = ",\\n", level = 3, indent.by = rk.get.indent())
}
\arguments{
-\item{cbox}{An object of class \code{XiMpLe.node} containing a \code{<checkbox>} node, as generated
+\item{cbox}{An object of class \code{XiMpLe.node} containing a \code{<checkbox>} node,
+ as generated
by \code{\link[rkwarddev:rk.XML.cbox]{rk.XML.cbox}}.}
-\item{true}{Logical or character, the value the option should get. E.g., if \code{true=TRUE} then the option will be
-set to \code{TRUE} if the box is checked, or in case \code{not=TRUE}, if the box is not checked.}
+\item{true}{Logical or character, the value the option should get. E.g.,
+ if \code{true=TRUE} then the option will be
+set to \code{TRUE} if the box is checked, or in case \code{not=TRUE},
+ if the box is not checked.}
-\item{not}{Logical, inverses the checked status of the checkbox. In other words, set this to \code{TRUE}
+\item{not}{Logical, inverses the checked status of the checkbox. In other words,
+ set this to \code{TRUE}
if you want the option to be set if the box is not checked.}
-\item{ifelse}{Logical, whether the options should be set anyway. By default, the option will only
-be set in one condition. If \code{ifelse=TRUE}, it will get the inverse value in case of the alternative
-condition, e.g. it will be set to either \code{not=TRUE} or \code{not=FALSE} if the box is checked or unchecked.}
+\item{ifelse}{Logical, whether the options should be set anyway. By default,
+ the option will only
+be set in one condition. If \code{ifelse=TRUE},
+ it will get the inverse value in case of the alternative
+condition,
+ e.g. it will be set to either \code{not=TRUE} or \code{not=FALSE} if the box is checked or unchecked.}
-\item{false}{Logical or character, the value the option should, only used get if \code{ifelse=TRUE} as well.
-E.g., if \code{false=FALSE} then the option will be set to \code{FALSE} if the box is not checked,
+\item{false}{Logical or character, the value the option should,
+ only used get if \code{ifelse=TRUE} as well.
+E.g.,
+ if \code{false=FALSE} then the option will be set to \code{FALSE} if the box is not checked,
or in case \code{not=TRUE}, if the box is checked.}
-\item{opt}{A character string, naming the R option to be set. If \code{NULL}, the XML ID of the checkbox node
+\item{opt}{A character string, naming the R option to be set. If \code{NULL},
+ the XML ID of the checkbox node
will be used.}
-\item{prefix}{A character string, what should be pasted before the actual option string. Default is a
+\item{prefix}{A character string,
+ what should be pasted before the actual option string. Default is a
comma and a newline.}
\item{level}{Integer, which indentation level to use, minimum is 1.}
@@ -43,7 +54,8 @@ An object of class \code{rk.JS.ite}.
This function is a basically shortcut for \code{\link[rkwarddev:ite]{ite}} with some assumptions.
It's thought to be used when a checkbox should turn an option of an R function to a specified value,
by default \code{TRUE} or \code{FALSE} (hence the name, abbreviated "true or false").
-The same result can be obtained with \code{ite}, but for most common cases \code{tf} is much quicker.
+The same result can be obtained with \code{ite},
+ but for most common cases \code{tf} is much quicker.
}
\examples{
# an example checkbox XML node
More information about the rkward-tracker
mailing list