[rkward-cvs] SF.net SVN: rkward:[3057] trunk/rkward/rkward
kapatp at users.sourceforge.net
kapatp at users.sourceforge.net
Wed Sep 22 07:12:25 UTC 2010
Revision: 3057
http://rkward.svn.sourceforge.net/rkward/?rev=3057&view=rev
Author: kapatp
Date: 2010-09-22 07:12:25 +0000 (Wed, 22 Sep 2010)
Log Message:
-----------
Add more Rd files for public functions. A lot of these are just skeleton files, will fill up later.
Modified Paths:
--------------
trunk/rkward/rkward/pages/rkward_public_functions.rkh
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
Added Paths:
-----------
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.label.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.misc.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.results.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sync.Rd
Modified: trunk/rkward/rkward/pages/rkward_public_functions.rkh
===================================================================
--- trunk/rkward/rkward/pages/rkward_public_functions.rkh 2010-09-21 14:45:33 UTC (rev 3056)
+++ trunk/rkward/rkward/pages/rkward_public_functions.rkh 2010-09-22 07:12:25 UTC (rev 3057)
@@ -15,12 +15,15 @@
</section>
<section title="Other functions" id="public_fns">
-
<ul>
- <li>See <link href="rkward://rhelp/rk.show.message"/> or <link href="rkward://rhelp/rk.show.question"/>.</li>
+ <li>Call plugins: <link href="rkward://rhelp/rk.call.plugin"/>.</li>
+ <li>Various editing (object and files) related functions are documented here: <link href="rkward://rhelp/rk.edit"/>.</li>
+ <li>Various output and results related functions are documented here: <link href="rkward://rhelp/rk.results"/>.</li>
+ <li>Various labels and names related functions are documented here: <link href="rkward://rhelp/rk.get.label"/>.</li>
+ <li>Various file name related functions are documented here: <link href="rkward://rhelp/rk.get.tempfile.name"/>.</li>
+ <li>Message boxes and selection lists: see <link href="rkward://rhelp/rk.show.message"/>.</li>
+ <li>Misc functions: <link href="rkward://rhelp/rk.misc"/> and <link href="rkward://rhelp/rk.sync"/>.</li>
</ul>
-
- TODO: add documentation for all functions from public.R
</section>
</document>
Added: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd (rev 0)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd 2010-09-22 07:12:25 UTC (rev 3057)
@@ -0,0 +1,28 @@
+\name{rk.call.plugin}
+\alias{rk.call.plugin}
+
+\title{TODO}
+
+\description{
+}
+
+\usage{
+rk.call.plugin(plugin, ..., submit.mode = c("manual", "auto", "submit"))
+}
+
+\arguments{
+}
+
+\details{
+}
+
+\value{
+ Returns \code{TRUE} invisibly.
+}
+
+\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
+
+\examples{
+}
+
+\keyword{utilities}
Added: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd (rev 0)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd 2010-09-22 07:12:25 UTC (rev 3057)
@@ -0,0 +1,42 @@
+\name{rk.edit}
+\alias{rk.edit}
+\alias{rk.edit.files}
+\alias{rk.show.files}
+\alias{rk.show.html}
+
+\title{Edit / show an object / file}
+
+\usage{
+rk.edit(x)
+rk.edit.files(file = file, title = file, name = NULL)
+rk.show.files(file = file, title = file, wtitle = NULL, delete = FALSE)
+rk.show.html(url)
+}
+
+\arguments{
+ \item{x}{an object}
+ \item{file}{character vector, filenames to edit. \bold{TODO} _check me_}
+ \item{title}{character vector, of the same length as \code{file}; used as ??? \bold{TODO} _complete me_}
+ \item{wtitle}{character vector, of the same length as \code{file}; used as the title strings of the displayed windows \bold{TODO} _check me_}
+ \item{delete}{a logical (not NA), when \code{TRUE} the shown file(s) are deleted after closing.}
+}
+
+\details{
+}
+
+\value{
+ All the functions return their corresponding internal call values. Except \code{rk.edit}, all other functions return invisibly. \bold{TODO} __fix me__
+}
+
+\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
+
+\seealso{
+ \code{\link{edit}}, \code{\link{file}}
+}
+
+\examples{
+\bold{TODO}
+}
+
+\keyword{utilities}
+\keyword{IO}
Added: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.label.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.label.Rd (rev 0)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.label.Rd 2010-09-22 07:12:25 UTC (rev 3057)
@@ -0,0 +1,49 @@
+\name{rk.get.label}
+
+\alias{rk.get.label}
+\alias{rk.set.label}
+\alias{rk.get.short.name}
+\alias{rk.get.description}
+\alias{rk.list.names}
+
+\title{Various label related utility functions}
+
+\usage{
+rk.get.label(x)
+rk.set.label(x, label, envir = parent.frame())
+rk.get.short.name(x)
+rk.get.description(..., paste.sep = NULL, is.substitute = FALSE)
+rk.list.names(..., deparse.level = 2)
+}
+
+\arguments{
+ \item{x}{any R object}
+ \item{label}{a string, to set the label attribute of an object}
+ \item{envir}{an environment, where the attribute is evaluated}
+ \item{paste.sep}{a string, used as the \code{collapse} argument for paste}
+ \item{is.substitute}{a logical (not NA), \bold{TODO} __explain me__}
+}
+
+\details{
+ \code{rk.get.label} retrieves the rkward label (if any) of the given object.
+
+ \code{rk.set.label} sets the rkward label (if any) of the given object.
+
+ \code{rk.get.short.name} creates a short name for the given object.
+
+ \code{rk.get.description} creates descriptive string(s) for each of the arguments in "\code{\dots}"; collapsing into a single string using \code{paste.sep} (if not NULL). \bold{TODO}: explain \code{is.substitute}.
+
+ \code{rk.list.names} returns the names of the arguments passed as \code{...}; in case of nested lists, deparsing only upto a depth given by \code{deparse.level}.
+}
+
+\value{
+ \code{rk.set.label} returns the result of the evaluation of "setting the label" while the others return a character vector.
+}
+
+\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
+
+\examples{
+\bold{TODO}
+}
+
+\keyword{utilities}
Added: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd (rev 0)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd 2010-09-22 07:12:25 UTC (rev 3057)
@@ -0,0 +1,36 @@
+\name{rk.get.tempfile.name}
+
+\alias{rk.get.tempfile.name}
+\alias{rk.get.output.html.file}
+\alias{rk.set.output.html.file}
+
+\title{Output file names}
+
+\usage{
+rk.get.tempfile.name(prefix="image", extension=".jpg")
+rk.get.output.html.file()
+rk.set.output.html.file(x)
+}
+
+\arguments{
+ \item{prefix}{a string, used as a filename prefix when saving images to the output file}
+ \item{extension}{a string, used as a filename extension when saving images to the output file}
+ \item{x}{a string, giving the filename of the of the output file}
+}
+
+\details{
+ In RKWard the output is saved as a html file which is located at "~/.rkward" (\bold{TODO}: make this platform free). The name of this html file can be retrieved and set using \code{rk.get.output.html.file} and \code{rk.set.output.html.file}. Images that are copied to output are also saved here. The filenames of these images are of the form "\code{prefix}%03d.\code{extension}"; which can be retrieved using \code{rk.get.tempfile.name}.
+}
+
+\value{
+ \code{rk.get.tempfile.name} and \code{rk.get.output.html.file} returns a string while \code{rk.set.output.html.file} returns \bold{TODO} NULL?
+}
+
+\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
+
+\examples{
+\bold{TODO}
+}
+
+\keyword{utilities}
+\keyword{IO}
Added: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.misc.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.misc.Rd (rev 0)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.misc.Rd 2010-09-22 07:12:25 UTC (rev 3057)
@@ -0,0 +1,32 @@
+\name{RKWard_misc}
+\alias{rk.misc}
+\alias{rk.rename.in.container}
+\alias{rk.make.repos.string}
+\alias{rk.select.CRAN.mirror}
+
+\title{TODO}
+
+\description{
+}
+
+\usage{
+rk.rename.in.container(x, old_name, new_name, envir = parent.frame())
+rk.make.repos.string()
+rk.select.CRAN.mirror()
+}
+
+\arguments{
+}
+
+\details{
+}
+
+\value{
+}
+
+\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
+
+\examples{
+}
+
+\keyword{utilities}
Added: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.results.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.results.Rd (rev 0)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.results.Rd 2010-09-22 07:12:25 UTC (rev 3057)
@@ -0,0 +1,35 @@
+\name{rk.results}
+\alias{rk.print}
+\alias{rk.print.literal}
+\alias{rk.header}
+\alias{rk.results}
+\alias{rk.describe.alternative}
+
+\title{TODO}
+
+\description{
+}
+
+\usage{
+rk.print(x, ...)
+rk.print.literal(x)
+rk.header(title, parameters = list(), level = 1)
+rk.results(x, titles = NULL)
+rk.describe.alternative(x)
+}
+
+\arguments{
+}
+
+\details{
+}
+
+\value{
+}
+
+\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
+
+\examples{
+}
+
+\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd 2010-09-21 14:45:33 UTC (rev 3056)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd 2010-09-22 07:12:25 UTC (rev 3057)
@@ -1,11 +1,12 @@
\name{rk.show.message}
\alias{rk.show.message}
\alias{rk.show.question}
+\alias{rk.select.list}
-\title{Message box using native KDE GUI}
+\title{Message boxes and selection list using native KDE GUI}
\description{
- Multi-purpose pop-up message boxes using native KDE GUI elements; used either to show some information or ask some question.
+ Multi-purpose pop-up message boxes and selection list using native KDE GUI elements. The message boxes can be used either to show some information or ask some question. The selection list can be used to get a vector of selected items.
}
\usage{
@@ -13,6 +14,8 @@
rk.show.question (message, caption = "Question",
button.yes = "yes", button.no = "no", button.cancel = "cancel")
+
+rk.select.list (list, preselect = NULL, multiple = FALSE, title = NULL)
}
\arguments{
@@ -22,32 +25,47 @@
\item{button.no}{a string used for the text label of the \bold{No} button, similar to \code{button.yes}.}
\item{button.canel}{a string used for the text label of the \bold{Cancel} button, similar to \code{button.yes}.}
\item{wait}{a logical (not NA) indicating whether the R interpreter should wait for the user's action, or run it asynchronously.}
+ \item{list}{a vector, coerced into a character vector.}
+ \item{preselct}{a vector, coerced into a character vector, items to be preselected.}
+ \item{multiple}{a logical (not NA), when \code{TRUE} multiple selection selection is allowed.}
+ \item{title}{a string, for the window title of the displayed list}
}
\details{
For \code{rk.show.question}, the R interpreter always waits for the user's choice.
+
+ \code{rk.select.list} replaces \code{utils::select.list} for the running session acting as a drop-in replacement for \code{tk_select.list}. Use \code{.rk.select.list.default} for the original \code{utils::select.list} function (see Examples).
}
\value{
\code{rk.show.message} always returns \code{TRUE}, invisibly.
\code{rk.show.question} returns \code{TRUE} for \bold{Yes}, \code{FALSE} for \bold{No}, and \code{NULL} for \bold{Cancel} actions.
+
+ \code{rk.select.list} returns the value of \code{\link{select.list}}.
}
\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
\seealso{
- \code{\link{system}}
+ \code{\link{system}}, \code{\link{select.list}}
}
\examples{
require (rkward)
+## Message boxes
if (rk.show.question ("Question:\nDo you want to know about RKWard?",
button.yes = "Yes, I do!", button.no = "No, I don't care!", button.cancel = "")) {
rk.show.message ("Message:\nRKWard is a KDE GUI for R.", "RKWard Info")
} else {
rk.show.message ("You must be joking!", "RKWard Info", wait = FALSE) ## Run asynchronously
}
+
+## Selection lists:
+rk.select.list (LETTERS, preselect = c("A", "E", "I", "O", "U"),
+ multiple = TRUE, title = "vowels")
+.rk.select.list.default (LETTERS, preselect = c("A", "E", "I", "O", "U"),
+ multiple = TRUE, title = "vowels")
}
\keyword{utilities}
Added: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sync.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sync.Rd (rev 0)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sync.Rd 2010-09-22 07:12:25 UTC (rev 3057)
@@ -0,0 +1,32 @@
+\name{rk.sync}
+\alias{rk.sync}
+\alias{rk.sync.global}
+
+\title{TODO}
+
+\usage{
+rk.sync(x)
+rk.sync.global()
+}
+
+\arguments{
+}
+
+\details{
+}
+
+\value{
+}
+
+\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
+
+\section{Warning}{
+This is not to be used by a normal user.
+}
+
+
+\examples{
+}
+
+\keyword{utilities}
+\keyword{misc}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the rkward-tracker
mailing list