[rkward-cvs] SF.net SVN: rkward:[3059] trunk/rkward/rkward/rbackend/rpackages/rkward/man
tfry at users.sourceforge.net
tfry at users.sourceforge.net
Wed Sep 22 10:34:54 UTC 2010
Revision: 3059
http://rkward.svn.sourceforge.net/rkward/?rev=3059&view=rev
Author: tfry
Date: 2010-09-22 10:34:54 +0000 (Wed, 22 Sep 2010)
Log Message:
-----------
Start filling in some blanks on the R help pages
Modified Paths:
--------------
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
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd 2010-09-22 07:25:55 UTC (rev 3058)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd 2010-09-22 10:34:54 UTC (rev 3059)
@@ -14,28 +14,33 @@
}
\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{x}{an object to edit.}
+ \item{file}{character vector, filenames to show or edit.}
+ \item{title}{character vector, of the same length as \code{file}; This can be used to give descriptive titles to each file, which will be displayed to the user.}
+ \item{wtitle}{character vector, of length 1. This will be used as the window title.}
\item{delete}{a logical (not NA), when \code{TRUE} the shown file(s) are deleted after closing.}
}
\details{
+ \code{rk.edit} can be used to edit an object in the RKWard data editor. Currently only \link{data.frame}s are supported. This is similar to \link{edit.data.frame}, but the function returns immediately, and the object is edit asynchronously.
+
+ \code{rk.edit.files}, \code{rk.show.files}, and \code{rk.show.html} are equivalent to \link{file.edit}, \link{file.show}, and \link{browseURL}, respectively, but use RKWard as text/html editor/viewer. Generally it is recommended to use \link{file.edit}, \link{file.show}, and \link{browseURL}, instead. These will call the respective RKWard functions by default, when run inside an RKWard session.
}
\value{
- All the functions return their corresponding internal call values. Except \code{rk.edit}, all other functions return invisibly. \bold{TODO} __fix me__
+ All functions described on this page return \code{NULL}, unconditionally.
}
\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
\seealso{
- \code{\link{edit}}, \code{\link{file}}
+ \code{\link{edit}}, \code{\link{file.edit}}, \code{\link{file.show}}, \code{\link{browseURL}}
}
\examples{
-\bold{TODO}
+## Not run
+x <- data.frame (a=c(1:3), b=c(2:4))
+rk.edit(x)
}
\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.label.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.label.Rd 2010-09-22 07:25:55 UTC (rev 3058)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.label.Rd 2010-09-22 10:34:54 UTC (rev 3059)
@@ -26,14 +26,14 @@
\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.set.label} sets the rkward label for 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}.
+
+ \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). If \code{is.substitute=TRUE}, the arguments will be deparsed, first, which can be useful when using \code{rk.get.description} inside a function.
+
+ \code{rk.list.names} returns the names of the arguments passed as \code{...}; when using \code{rk.list.names} inside a function, it may be necessary to increase the \code{deparse.level} level.
}
\value{
@@ -43,7 +43,12 @@
\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
\examples{
-\bold{TODO}
+x <- data.frame(a=c(1:3), b=c(2:4))
+rk.set.label(x[["a"]], "First column")
+rk.get.short.name (x$a) # "x$a"
+rk.get.label (x$a) # "First column"
+rk.get.description (x$a) # "x$a (First column)"
+rk.list.names (x, x$a, x$b) # "x" "x$a" "x$b"
}
\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd 2010-09-22 07:25:55 UTC (rev 3058)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd 2010-09-22 10:34:54 UTC (rev 3059)
@@ -19,21 +19,35 @@
}
\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}.
+ In RKWard the output is saved as a html file which is located at "~/.rkward" by default. (\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}.
+
+ \code{rk.get.tempfile.name} returns a non-existing filename inside the directory of the output file. It is mainly used by \link{rk.graph.on} to create filenames suitable for storing images in the output. The filenames of the temporary files are of the form "\code{prefix}%03d.\code{extension}". \code{rk.get.tempfile.name} is somewhat misnamed. For truly temporary files, \link{tempfile} is generally more suitable.
}
\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?
+ \code{rk.get.tempfile.name} and \code{rk.get.output.html.file} returns a string while \code{rk.set.output.html.file} returns \code{NULL}?
}
\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
\seealso{
-\url{rkward://page/rkward_output}
+\url{rkward://page/rkward_output}, \link{tempfile}, \link{file}, \link{rk.print}
}
\examples{
-\bold{TODO}
+testfile.name <- rk.get.tempfile.name(prefix="test", extension=".txt")
+testfile <- file(testfile.name)
+cat("This is a test\n", file=testfile)
+close(testfile)
+unlink(testfile.name)
+
+outfile <- rk.get.output.html.file()
+
+## Not run
+rk.set.output.html.file("~/.rkward/another_file.html")
+rk.header("Output on a different output file")
+rk.show.html(rk.get.output.html.file())
+rk.set.output.html.file(outfile)
}
\keyword{utilities}
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