[rkward-cvs] SF.net SVN: rkward:[3329] branches/jss_dec_10/FINAL_JSS_TEX
kapatp at users.sourceforge.net
kapatp at users.sourceforge.net
Mon Dec 27 06:09:26 UTC 2010
Revision: 3329
http://rkward.svn.sourceforge.net/rkward/?rev=3329&view=rev
Author: kapatp
Date: 2010-12-27 06:09:26 +0000 (Mon, 27 Dec 2010)
Log Message:
-----------
minor edits
Modified Paths:
--------------
branches/jss_dec_10/FINAL_JSS_TEX/GUI_elements.tex
branches/jss_dec_10/FINAL_JSS_TEX/RKWard_paper.tex
branches/jss_dec_10/FINAL_JSS_TEX/background.tex
branches/jss_dec_10/FINAL_JSS_TEX/conclusion_summary_acknowledgments.tex
Modified: branches/jss_dec_10/FINAL_JSS_TEX/GUI_elements.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/GUI_elements.tex 2010-12-27 02:13:40 UTC (rev 3328)
+++ branches/jss_dec_10/FINAL_JSS_TEX/GUI_elements.tex 2010-12-27 06:09:26 UTC (rev 3329)
@@ -7,9 +7,9 @@
parts, as depicted in Figure~\ref{fig:main_window}. While many aspects
of the GUI can be customized by the user, for simplicity we will
describe the default appearance of RKWard in the present section. The
-top of the window is occupied by menu bar and toolbar (Figure~
-\ref{fig:main_window}A). The content of both bars is partially context
-sensitive, e.\,g., the Edit menu will offer
+top of the window is occupied by menu bar and toolbar
+(Figure~\ref{fig:main_window}A). The content of both bars is partially context
+sensitive, e.\,g., the ``Edit'' menu will offer
one set of actions when the current document window is a data editor,
and another set of actions for a \proglang{R} script
editor window. To ease orientation, all top level menus remain
@@ -154,8 +154,8 @@
predefined shortcuts (and toolbar icons) for submitting the current line, the current
selection, predefined blocks, or the entire document to the
\proglang{R} engine for evaluation. It also
-offers object-name completion and function argument hinting (Figure
-\ref{fig:code_hinting}A and B) based on the objects present in
+offers object-name completion and function argument hinting
+(Figure~\ref{fig:code_hinting}A and B) based on the objects present in
the \proglang{R} workspace\footnote{The object-name
completion and function argument hinting features in RKWard predate the
inclusion of similar features into the core
@@ -166,7 +166,7 @@
paste the clipboard content (e.\,g., from a separate spreadsheet
application) as a single string, vector, or matrix, suitable
for inclusion in an \proglang{R} script, optionally
-transforming it in advance (Figure \ref{fig:special_paste}).
+transforming it in advance (Figure~\ref{fig:special_paste}).
\begin{figure}[htp]
\centering
@@ -188,7 +188,7 @@
Script editor windows can be created by opening an existing
\proglang{R} script file from the file browser, the
-``File''-menu, or by creating a new empty script. It can
+``File'' menu, or by creating a new empty script. It can
also be invoked from \proglang{R}, e.\,g., using the
\code{file.edit()}, \code{file.show()}, or \code{fix()}
commands.
@@ -229,7 +229,7 @@
be created and opened from the GUI, and existing objects can be opened
for editing from the workspace browser. For opening objects from
\proglang{R} code, the function \code{rk.edit()} can be used.
-Figure \ref{fig:data_editors} shows multiple \code{data.frame}s open for editing.
+Figure~\ref{fig:data_editors} shows multiple \code{data.frame}s open for editing.
\begin{figure}[htp]
\centering
@@ -283,7 +283,7 @@
RKWard supports working with multiple objects simultaneously, rather than
limiting actions to a single active \code{data.frame}, as with e.\,g., \pkg{Rcmdr} or
\pkg{DeduceR}. Given this non-modal interface design, multiple data editor
-windows can be opened at once (Figure \ref{fig:data_editors}).
+windows can be opened at once (Figure~\ref{fig:data_editors}).
\subsection{Handling, manipulating, and analyzing data}
\label{sec:analyzing_data}
@@ -327,7 +327,7 @@
Further options are available from the tabbed pages of the central area.
The right-side area is common to all data handling
-dialogs. Here the ``Submit button'' is used
+dialogs. Here the ``Submit'' button is used
to start the import action. It is enabled once all required
settings have been made, i.\,e., in this case a file name has been
selected. The ``Close'' button will close the
@@ -335,7 +335,7 @@
The bottom area optionally shows the \proglang{R}
code corresponding to the current settings, and which will be run
-upon pressing the ``Submit button'' (see Section~\ref{sec:importing_data} for generated \proglang{R} code).
+upon pressing the ``Submit'' button (see Section~\ref{sec:importing_data} for generated \proglang{R} code).
The code display is hidden by default and can be revealed using
the ``Code'' button. This
generated code display is updated dynamically as the user changes settings, allowing
@@ -360,7 +360,7 @@
and adding a grid to an existing plot
(works on only certain types of plots). Further, a history mechanism is provided,
which stores most created plots automatically and allows to navigate
-back to earlier plots (Figure \ref{fig:plot_history}).
+back to earlier plots (Figure~\ref{fig:plot_history}).
The history is available as a drop down list of the plot calls as well as using typical ``back''
and ``forward'' buttons on the toolbar.
The maximum number
@@ -388,7 +388,7 @@
Further, RKWard provides access to different plotting functions using GUI dialogs,
available from the ``Plots'' menu. Wherever appropriate, RKWard supports a ``plot
preview'' feature. If the ``Preview'' box of
-the respective dialog is checked (c.\,f., Figure \ref{fig:boxplot1}), a device window is opened, which
+the respective dialog is checked (see Figure~\ref{fig:boxplot1}), a device window is opened, which
shows the plot as it would be created with the current settings. The
preview is updated automatically as the user makes changes, allowing to
see the effect of each setting instantly\footnote{The preview is
@@ -422,7 +422,7 @@
identical parameters\footnote{In case not all parameters could be
reused, since, may be, some of the objects in
question are no longer available, the user will be notified.} (see
-Figure \ref{fig:results_output}). Thus, the ``Run
+Figure~\ref{fig:results_output}). Thus, the ``Run
Again'' feature combines the documentation of the result
with an automated way to conduct the same analysis again on new
data, providing benefits similar to, for example, the automated report generation
@@ -547,7 +547,7 @@
RKWard GUI dialogs will typically link to documentation for both
related RKWard dialogs and the underlying \proglang{R} functions.
It worthwhile to note here that, the TDI interface of the document view area
-(c.\,f., Figure \ref{fig:main_window}C) allows to utilize arbitrary number of document
+(c.\,f., Figure~\ref{fig:main_window}C) allows to utilize arbitrary number of document
windows for browsing these help pages simultaneously.
%The help system can be invoked through several actions in the
@@ -576,7 +576,7 @@
reference) while the cursor is on a function name either in the code editor or
in the \proglang{R} console, and of course, by using the \proglang{R} \code{help()}
command. In addition, a tool view window\footnote{Note the ``Help search''
-tool in Figure \ref{fig:main_window}E.} is provided as an interface to the
+tool in Figure~\ref{fig:main_window}E.} is provided as an interface to the
\code{help.search()} command in \proglang{R}. This allows to search all installed,
all loaded, and related \proglang{R} packages for a specified topic.
Modified: branches/jss_dec_10/FINAL_JSS_TEX/RKWard_paper.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/RKWard_paper.tex 2010-12-27 02:13:40 UTC (rev 3328)
+++ branches/jss_dec_10/FINAL_JSS_TEX/RKWard_paper.tex 2010-12-27 06:09:26 UTC (rev 3329)
@@ -28,7 +28,7 @@
Interface (GUI), but it includes tools for building such. Over the past
years, proprietary and non-proprietary GUI solutions have emerged,
based on internal or external tool kits, with different scopes and technological concepts.
-For example, \proglang{Rgui.exe} and \proglang{Rgui.app} have
+For example, Rgui.exe and Rgui.app have
become the de facto GUI on the MS Windows and MacOS X platforms, respectively, for most users.
In this paper we discuss RKWard which aims to be both a
comprehensive cross-platform GUI and an Integrated Development Environment
Modified: branches/jss_dec_10/FINAL_JSS_TEX/background.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/background.tex 2010-12-27 02:13:40 UTC (rev 3328)
+++ branches/jss_dec_10/FINAL_JSS_TEX/background.tex 2010-12-27 06:09:26 UTC (rev 3329)
@@ -34,7 +34,7 @@
or by allowing to implement routinely performed tasks as a GUI element. In
addition, many features like the integrated data editor and the plot preview
will be useful to \proglang{R} novices and \proglang{R} experts alike in their everyday work
-(see Section \ref{sec:user_interface}).
+(see Section~\ref{sec:user_interface}).
RKWard provides a high level of transparency about the steps that are needed to
perform any supported task in \proglang{R}, in order to make it easy for the user to see
@@ -60,7 +60,7 @@
artificial limitations on how users can work with the application. For example,
the user is not limited to using only one \code{data.frame} or one model at a
time. RKWard is designed to allow users to even create custom GUI dialogs
-easily (see Sections \ref{sec:technical_plugins} and \ref{sec:example_plugin}).
+easily (see Sections~\ref{sec:technical_plugins} and \ref{sec:example_plugin}).
RKWard is licensed under the terms of the GNU GPL (general public license) Version 2
or higher. However, due to its dependencies, RKWard binaries are effectively
@@ -81,7 +81,7 @@
In this paper we will first give an overview over the main GUI elements and
features of RKWard (Section~\ref{sec:user_interface}), followed by a short example
-of a simple RKWard session (Section~\ref{sec:using_RKWard}). Next technical
+of a simple RKWard session (Section~\ref{sec:using_RKWard}). Next, technical
details of the implementation will be discussed, comparing them briefly to
competing GUI solutions, where appropriate (Section~\ref{sec:technical}).
Finally, we show an example for creating a plugin extension to RKWard
Modified: branches/jss_dec_10/FINAL_JSS_TEX/conclusion_summary_acknowledgments.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/conclusion_summary_acknowledgments.tex 2010-12-27 02:13:40 UTC (rev 3328)
+++ branches/jss_dec_10/FINAL_JSS_TEX/conclusion_summary_acknowledgments.tex 2010-12-27 06:09:26 UTC (rev 3329)
@@ -1,7 +1,7 @@
\section{Conclusion and outlook}
\label{sec:conclusion_summary}
In this article we have introduced the RKWard GUI to \proglang{R}. RKWard provides features ranging
-from easy to use dialogs for common statistical procedures, targetted at \proglang{R} novices, to advanced
+from easy to use dialogs for common statistical procedures targetted at \proglang{R} novices, to advanced
IDE features targetted at \proglang{R} experts.
RKWard tries to empower users of all knowledge levels to make more efficient use of the
@@ -11,7 +11,7 @@
\item provides full transparency about the \proglang{R} code that is used to carry out tasks.
\item avoids introducing RKWard-specific \proglang{R} functions for central functionality (but uses some for output formatting).
\item avoids hard dependencies on third-party \proglang{R} packages.
- \item uses standard \proglang{R} formats \citep[cf.][]{RDCT2010c} for data storage, and open standards (\proglang{HTML}, \proglang{PNG}, \proglang{SVG}) for storage of output.
+ \item uses standard \proglang{R} formats \citep[see][]{RDCT2010c} for data storage, and open standards (\proglang{HTML}, PNG, SVG) for storage of output.
\end{itemize}
Future versions of RKWard will continue to add value for both groups of users. Planned features include
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