[rkward-cvs] SF.net SVN: rkward:[3330] branches/jss_dec_10/FINAL_JSS_TEX

tfry at users.sourceforge.net tfry at users.sourceforge.net
Mon Dec 27 14:30:10 UTC 2010


Revision: 3330
          http://rkward.svn.sourceforge.net/rkward/?rev=3330&view=rev
Author:   tfry
Date:     2010-12-27 14:30:10 +0000 (Mon, 27 Dec 2010)

Log Message:
-----------
Assorted editing on the first half of the article.
Larger edits are explained by comments directly in the document.
Mail on the list will follow, shortly.

Modified Paths:
--------------
    branches/jss_dec_10/FINAL_JSS_TEX/GUI_elements.tex
    branches/jss_dec_10/FINAL_JSS_TEX/background.tex
    branches/jss_dec_10/FINAL_JSS_TEX/installing_starting_RKWard.tex
    branches/jss_dec_10/FINAL_JSS_TEX/technical.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 06:09:26 UTC (rev 3329)
+++ branches/jss_dec_10/FINAL_JSS_TEX/GUI_elements.tex	2010-12-27 14:30:10 UTC (rev 3330)
@@ -4,10 +4,10 @@
 For a use-case oriented example of an RKWard session, see Section~\ref{sec:using_RKWard}.
 
 The default layout of the main application window is divided into five
-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 
+parts, as depicted in Figure~\ref{fig:main_window}\footnote{
+ Many aspects of the RKWard GUI can be customized by the user. For simplicity we will
+ describe the default appearance of RKWard, only.
+}. 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
 one set of actions when the current document window is a data editor,
@@ -22,18 +22,18 @@
 \begin{figure}[htp]
  \centering
  \includegraphics[width=15.446cm,height=10.949cm]{../figures/main_window.png}
+%% TF: I've shortened the caption to basically just list each area. We already give
+%% descriptions in the main text. The previous version of the caption seemed to repeat a lot
+%% but not all of that.
+%% Perhaps area D should include the tool buttons, and E only the statusbar?
  \caption{Default RKWard main window after start up. 
-A) Menubar and toolbar, B) navigator element, C) editor, output, 
-and data management. D) embedded \proglang{R} console. 
-E) In addition to the menu bar at the top A) toolbar buttons 
-on the bottom of the main window give quick access to the command log, 
-running jobs, an \proglang{R} console, and the \proglang{R} help. 
-RKWard main window. Panels B) and D) can be resized or collapsed. The navigator element B)
-presents detailed information (e.\,g., type, class) about objects and their properties.}
+A) Menubar and toolbar, B) tool panel showing workspace browser, C) main view area, showing
+a help page D) tool panel showoing embedded \proglang{R} console E) tool buttons, and status bar.
+Panels B) and D) can be resized or collapsed.}
  \label{fig:main_window}
 \end{figure}
 
-A status bar is shown at the bottom of the window. It displays (from
+A status bar is shown at the bottom of the window (Figure~\ref{fig:main_window}E). It displays (from
 right to left) the status of the \proglang{R} engine (busy or idle), the
 current working directory, and a multi purpose region for additional
 information on some menu items and other GUI elements, visible when
@@ -53,8 +53,8 @@
 log (Section~\ref{sec:further_tool_windows}), Pending Jobs (Section~\ref{sec:further_tool_windows}), \proglang{R} Console
 (Section~\ref{sec:using_R_console}), and Help Search (Section~\ref{sec:help_system}).
 
-The remainder of the central area (Figure~\ref{fig:main_window}C) is a single row Tab Document
-Interface (TDI) for different documents. Early uses of TDIs date back to 1988 and are
+The remainder of the central area (Figure~\ref{fig:main_window}C) is a single row tabbed document
+interface (TDI) for different documents. Early uses of TDIs date back to 1988 and are
 widely applied nowadays \citep{Hopkins2005, MDN2010,
 KimLutteroth2010}. Currently, the supported types of
 documents are object summaries (Section~\ref{sec:workspace_browser_object_viewer}), 
@@ -65,7 +65,7 @@
 The order of tabs can be conveniently re-arranged
 using drag \& drop.
 
-Both document windows and tool views can be detached and re-attached from the main
+All document windows and tool views can be detached and re-attached from the main
 window as independent windows, managed by the window manager. This feature allows to 
 conveniently work with multiple documents
 at the same time, e.\,g., scripts or data editors. On{}-screen
@@ -89,12 +89,12 @@
 The choice of available actions on the tool bar can be
 configured via ``Settings$\rightarrow$Configure Toolbars''. Further, it is possible to add and remove sets
 of data manipulation and analysis features from the GUI, using
-``Settings$\rightarrow$Configure RKWard/Plugins''.
+``Settings$\rightarrow$Configure RKWard$\rightarrow$Plugins''.
 
 \subsection{Workspace browser and object viewer}
 \label{sec:workspace_browser_object_viewer}
 
-The workspace browser allows to view
+The workspace browser (Figure~\ref{fig:main_window}B) allows to view
 and manipulate \proglang{R} objects, similar
 to a regular file-system browser. This includes both, user objects
 (data, functions, environments) in \code{.GlobalEnv} and non-user objects in other environments in the
@@ -110,14 +110,7 @@
 depending on the type of object. Further, objects inside \code{.GlobalEnv} can be
 removed, renamed, and edited from the context menu.
 
-Literally hundreds or even thousands of objects are present in a typical
-\proglang{R} session. This can be overwhelming at
-first, therefore, the workspace browser has options to show only a certain
-subset of objects, e.\,g., only functions or only data objects, including
-or excluding hidden objects (object names starting with a 
-``.''), or showing only the contents of \code{.GlobalEnv} as
-opposed to all environments in the search path.
-
+%% TF: I swapped the below two paragraphs.
 Several actions are available from a context menu (after right-clicking
 on the object names), depending on the type of object. These allow to search the
 \proglang{R} help for information on that object, to
@@ -131,6 +124,14 @@
 tabs which show the output of
 \code{print()} and \code{summary()} calls.
 
+Literally hundreds or even thousands of objects are present in a typical
+\proglang{R} session. This can be overwhelming at
+first, therefore, the workspace browser has options to show only a certain
+subset of objects, e.\,g., only functions or only data objects, including
+or excluding hidden objects (object names starting with a 
+``.''), or showing only the contents of \code{.GlobalEnv} as
+opposed to all environments in the search path.
+
 An object list similar to the workspace browser (but showing only 
 \code{.GlobalEnv} by default) is also used in several places for the
 selection of objects to work with, e.\,g., in an analysis plugin (see Section~\ref{sec:analyzing_data}).
@@ -141,8 +142,7 @@
 
 RKWard comes with an advanced
 \proglang{R} script editor, based on the
-\proglang{KDE} Advanced Text Editor component
-(\url{http://kate-editor.org/}). Features of this
+\proglang{KDE} advanced text editor component (Kate; \url{http://kate-editor.org/}). Features of this
 editor include syntax highlighting (both on screen and in printouts; for
 \proglang{R} and many other script types), code
 folding, block-wise indentation adjustments or commenting, automatic
@@ -154,9 +154,9 @@
 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 
+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
+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
 \proglang{R} distribution. For this reason, they are
@@ -207,11 +207,11 @@
 like \proglang{R} running in a terminal. Adding to that, it provides many of the
 features which are also available in the code editor (see Section~\ref{sec:code_editor}).
 Most prominently, it supports syntax highlighting, code
-folding, function argument hinting, object-name completion, and pasting
+folding, function argument hinting, object name completion, and pasting
 vector or matrix data directly from the clipboard.
 
 By default, any code that is submitted to the
-\proglang{R} engine from the code-editor or from help
+\proglang{R} engine from the code editor or from help
 pages, is sent through the \proglang{R} console.
 However, it can be configured to the submitted in the background,
 instead.
@@ -235,9 +235,9 @@
  \centering
  \includegraphics[width=15.5cm]{../figures/data_editors.png}
  \caption{RKWard with several \code{data.frame}s in use at the same time. A) 
-  One \code{data.frame} is opened for editing in the main window. Further 
-  two documents (\code{data.frame}s) are opened in the background. 
-  B) A second \code{data.frame} is opened as detached window. 
+  One \code{data.frame} is opened for editing in the main window. Two further \code{data.frame}s
+  are opened in the background in tabs. 
+  B) Another \code{data.frame} is opened as detached window. 
   C) \proglang{R}'s standard data editing features (e.\,g., \code{fix()}, \code{edit()}) 
   are also usable within an RKWard session. In this example \code{fix(DNase)} 
   was invoked from the console (arrow).}
@@ -296,28 +296,29 @@
 \proglang{R} and its numerous add-on packages, this
 can basically be accomplished by defining GUI dialogs, generating
 \proglang{R} code according to the settings made in
-the GUI, and have the generated code evaluated by the
+the GUI, and having the generated code evaluated by the
 \proglang{R} engine. 
 This general pattern, implemented as plugins, is the
 basic recipe for most of the functionality provided by RKWard
-(see Section~\ref{sec:technical_plugins} for details). 
-Note that on purpose, RKWard does not have its
-own file format for data import and export. That is, it is possible
-to import data from several sources (see below) or to save and load
-\proglang{R} workspaces.
-For
+(see Section~\ref{sec:technical_plugins} for details). For
 the purpose of this article we will look at the standard
 elements of data handling functions by example of importing CSV
-(comma-separated values) data.
+(comma-separated values) data\footnote {
+  Note that on purpose, RKWard does not have its
+  own file format for data import and export, but rather uses
+  \proglang{R} workspaces as default data format. Additionally, it is possible
+  to import data from several sources as described in this section. Of course, further formats can
+  also be imported using copy \& paste (see Sections~\ref{sec:code_editor} and \ref{sec:spreadsheet}), or by
+  manually entering appropriate \proglang{R} commands in
+  the \proglang{R} console (Section~\ref{sec:using_R_console}).
+}. Further examples are given in Section~\ref{sec:using_RKWard}.
 
+%% TF: The figure that we reference here is quite a loooong stretch away. I think we
+%% should repeat it here (and with no filename entered, yet, as that is the state which the text describes).
 At the time of this writing, RKWard provides support for importing SPSS, 
 Stata, and ``delimited text'' data. Internally, RKWard
-relies on \proglang{R} packages for certain sets of
-data which were already described elsewhere
-\citep{Murdoch2002}. Of course, further formats can
-also be imported using copy \& paste (see Sections~\ref{sec:code_editor} and \ref{sec:spreadsheet}), or by
-manually entering appropriate \proglang{R} commands in
-the \proglang{R} console (Section~\ref{sec:using_R_console}). To import CSV
+relies on standard \proglang{R} functions and the package \pkg{foreign}
+\citep{Murdoch2002} for reading these data files. To import CSV (comma separated values)
 data, select ``File$\rightarrow$Import format$\rightarrow$Import Text$\rightarrow$CSV''
 data from the menu. This will open the dialog shown in
 Figure~\ref{fig:import_data}A. The central area of this dialog provides 
@@ -329,7 +330,7 @@
 The right-side area is common to all data handling
 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
+settings have been made, i.\,e., in this case, once a file name has been
 selected. The ``Close'' button will close the
 dialog without taking any action.
 
@@ -358,8 +359,10 @@
 bar and toolbar give access to a number of different functions,
 including GUI dialogs for exporting the current plot,
 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
+(works on only certain types of plots).
+
+Further, a history mechanism is provided,
+which stores created plots automatically and allows to navigate
 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.
@@ -380,19 +383,20 @@
   available as a drop-down list, allowing to jump directly to a previous 
   plot. In this example, five different plots were performed on the same data 
   set of a random sample (\code{rnorm()}). The plot can be 
-  selectively exported as described in Figure~\ref{fig:boxplot2} via ``Device$\rightarrow$Export''.
+  exported via ``Device$\rightarrow$Export'' as described in Section~\ref{sec:create_plot}.
 }
  \label{fig:plot_history}
 \end{figure}
 
 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
+preview'' feature. When the ``Preview'' box of
 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
-updated asynchronously to keep the GUI responsive; see Section~\ref{sec:technical_graphics}.}. For example, the CLT plugins
+updated asynchronously to keep the GUI responsive; see Section~\ref{sec:technical_graphics}.}. For example, the CLT 
+(central limit theorem) plugins
 under the ``Distributions'' menu can be very helpful to dynamically ``show''
 the convergence in distribution while teaching. For the sake of simplicity, such preview plots are not added to
 the history.
@@ -426,15 +430,19 @@
 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
-available from \pkg{RreportGenerator}\footnote{The application generates automatic
-reports from routine statistical analysis in bioinformatical
-applications.} \citep{RaffelsbergerW2008}.
+available from \pkg{RreportGenerator} \citep{RaffelsbergerW2008}.
 
+%%TF: I think the reader can easily guess that it is about automatic report generation from the context.
+%% So I've removed this footnote.
+%\footnote{The application generates automatic
+%reports from routine statistical analysis in bioinformatical
+%applications.}
+
 \begin{figure}[htp]
  \centering
  \includegraphics[width=15.5cm]{../figures/results_output_cropped.png}
- \caption{Sample contents of the output window. DNase data of the \pkg{data} package was used. 
-  Standard elements of plugin output include  a standardized header, and a 
+ \caption{Sample contents of the output window. \code{DNase} data of the \pkg{datasets} package was used. 
+  Standard elements of plugin output include a standardized header, and a 
   ``Run again''-link, which allows to repeat the analysis with identical or 
   similar parameters.}
  \label{fig:results_output}
@@ -451,7 +459,7 @@
 ($\sim\!$/.rkward, by default). It is also
 possible to select and copy sections of the output directly from the
 output window, and to paste them into office applications as
-richly formatted text; even images and tables can be easily copied by drag \& drop. In future releases, 
+richly formatted text; even images and tables can be easily copied by drag \& drop to many office applications. In future releases, 
 it is planned to integrate RKWard
 with existing office suites. This
 will possibly also mean addition of different file formats such as ODF (open
@@ -487,9 +495,13 @@
 RKWard supports installing packages to any user writable location. If no current
 library location is user writable, RKWard offers to create a new one. 
 On UNIX systems, interactively acquiring root privileges for
-installation to the system-wide libraries is also supported. If used to
-update already installed packages, the user can choose to either
-update all packages at once, or only the selected ones. The installation process
+installation to the system-wide libraries is also supported.
+%% TF: I think this feature is so naturally to be expected, that mentioning it,
+%% explicitly, sounds awkward:
+%If used to
+%update already installed packages, the user can choose to either
+%update all packages at once, or only the selected ones.
+The installation process
 itself can be monitored at the interface for error tracking. At the time of this writing, RKWard has no
 built-in tools for the interactive exploration of \proglang{R} packages. However, it is
 possible to invoke external helpers \citep{Zhang2004}.
@@ -500,7 +512,7 @@
 The file browser tool window can be
 used to open supported file types (e.\,g., \proglang{R}
 scripts, \proglang{HTML} files) inside the main RKWard
-window. For unsupported file types (such as PDF), the
+window. For unsupported file types (such as PDF; portable document format), the
 systems default external applications are used.
 
 The command log window contains a log of the commands that have been
@@ -536,19 +548,20 @@
 %related RKWard dialogs and the underlying
 %\proglang{R} functions.
 
-RKWard provides access to both \proglang{R}  specific and 
-RKWard specific help pages seamlessly in a unified framework. 
-The former includes documentation on \proglang{R} functions and packages 
-and the various R manuals; while the later includes help pages on 
-RKWard in general and on specific GUI dialogs\footnote{For technical 
+RKWard provides access to both \proglang{R} specific and 
+RKWard specific help pages.
+%% TF: Well, I wouldn't really call it seamless. The fact that it's all in one window, and cross-linked is mentioned, below.
+% seamlessly in a unified framework. 
+\proglang{R} specific documentation includes help pages for functions and packages 
+and the various \proglang{R} manuals. RKWard specific documentation consists of
+help pages on RKWard in general and on specific GUI dialogs\footnote{For technical 
 backgound of RKWard GUI help pages please refer to Section~\ref{sec:technical_plugins_defining}.}. 
 All these various types of help pages can be browsed in the same document 
-window, and are appropriately cross--linked. For example, help pages for
+window, and can be cross--linked. For example, help pages for
 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 
-windows for browsing these help pages simultaneously.
+An arbitrary number of help windows can be browsed simultaneously, in the
+TDI view area (c.\,f., Figure~\ref{fig:main_window}C) or in detached windows.
 
 %The help system can be invoked through several actions in the
 %Help menu. Help pages on RKWard dialogs can be
@@ -567,7 +580,7 @@
 %loaded, or specific \proglang{R} packages for a
 %specified topic.
 
-An easy way to access the help system is the ``Help'' menu. Help pages on
+A central access point to the help system is the ``Help'' menu. Further, help pages on
 RKWard GUI dialogs can be accessed from the dialog itself using the
 ``Help'' button. An useful (``reverse'') feature here is that these pages include 
 a link near the top of the page to start the corresponding GUI dialog directly.
@@ -575,13 +588,12 @@
 such as, the context menu of the workspace browser, by pressing F2 (function
 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
+command. In addition, a tool view window 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.
+all loaded, or specific \proglang{R} packages for a specified topic.
 
 The help browser window is based on the \proglang{KDE}
-\proglang{HTML} viewer component and supports typical
+\proglang{HTML} viewer component and supports many standard
 features like increasing or decreasing the font size and searching text
 within a page. Additionally, \proglang{R} code inside a help
 page can be sent to the \proglang{R} engine for

Modified: branches/jss_dec_10/FINAL_JSS_TEX/background.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/background.tex	2010-12-27 06:09:26 UTC (rev 3329)
+++ branches/jss_dec_10/FINAL_JSS_TEX/background.tex	2010-12-27 14:30:10 UTC (rev 3330)
@@ -9,17 +9,22 @@
 Development Core Team \citep{RDCT2001, RDCT2010, Ihaka_Gentlemen_1993}.
 \proglang{R} does not include an advanced cross-platform GUI (graphical user interface) as known from other
 statistical software packages. However, \proglang{R} includes tools for building GUIs
-mainly based on \proglang{Tlc/Tk} \citep{Dalgaard2001, Dalgaard2002}. Since then a
+mainly based on \proglang{Tlc/Tk} \citep{Dalgaard2001, Dalgaard2002}. Meanwhile a
 plethora of \proglang{R} GUIs have emerged (see \url{http://www.sciviews.org/_rgui/} for a
-comprehensive list). In 2005 John Fox released version 1.0 of \proglang{R} Commander, which
+comprehensive list). In 2005 John Fox released version 1.0 of \proglang{R} Commander (package \pkg{Rcmdr}, which
 can be considered a milestone in \proglang{R} GUI development; it was the first GUI
-implementation that was able to deliver the experience of statistical tests,
-plots and data manipulation easily accessible for \proglang{R} novices as well as advanced
-users. However, John Fox stated that \proglang{R} Commander's target was to provide
-functionality for basic-statistical courses; though the features have increased over
+implementation that was able to make statistical tests,
+plots and data manipulation easily accessible for \proglang{R} novices.
+%% TF: I've removed the part ``as well as advanced users``, also to better explain in how
+%% far RKWard follows a different philosophy than Rcmdr.
+%% While of coure Rcmdr is usable by advanced users, it does not offer much added value
+%% for R experts in the way that RKWard does. So certainly the target audience is R novices
+%% or learners.
+John Fox stated that \pkg{Rcmdr}'s target was to provide
+functionality for basic-statistical courses, though the features have increased over
 time beyond this \citep{Fox2005, Fox2007}. In November 2002 Thomas Friedrichsmeier
-started the RKWard open-source software project with the goal to create an
-implementation of an \proglang{R} GUI-based on \proglang{KDE} and \proglang{Qt} technologies.
+started the RKWard open-source software project with the goal to create a GUI to
+\proglang{R} based on \proglang{KDE} and \proglang{Qt} technologies.
 
 The scope of RKWard is deliberately broad, targeting both \proglang{R} novices and experts.
 For the first group, the aim is to allow any person with knowledge on
@@ -41,13 +46,12 @@
 complete codes for all GUI actions\footnote{
   This distinguishes RKWard from \proglang{R} GUIs such as Red-R (\url{http://www.red-r.org/}), which 
   specifically aims to hide the complexities of the \proglang{R} programming language, following the concept of visual data-flow 
-  programming \citep{Sutherland1966}.
-}. In doing so, RKWard deliberately generates\footnote{
-  RKWard limits itself to generate \proglang{R} code from GUI settings.
-} relatively verbose code. It avoids wrapping complex sequences of data
+  programming \citep{Sutherland1966}. In contrast, RKWard limits itself to generate \proglang{R} code from GUI settings.
+}. In doing so, RKWard deliberately generates
+comparatively verbose code. It avoids wrapping complex sequences of data
 manipulation or analysis into custom high-level \proglang{R} functions. The task of
 providing high-level functions is logically independent of the development of the
-GUI frontend, and should best be addressed in dedicated \proglang{R} packages, if necessary.
+GUI frontend, and should best be addressed in dedicated \proglang{R} packages, where necessary.
 This approach allows to make better use of the modular design of \proglang{R}, avoids
 locking-in users to a specific GUI application, and provides them with more options for
 customizing the generated code patterns.
@@ -59,7 +63,7 @@
 rather oriented at statistical tasks. Furthermore, RKWard does not impose
 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
+time. RKWard is designed to allow users to create custom GUI dialogs
 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
@@ -85,4 +89,4 @@
 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 
-(Section~\ref{sec:example_plugin}).
\ No newline at end of file
+(Section~\ref{sec:example_plugin}).

Modified: branches/jss_dec_10/FINAL_JSS_TEX/installing_starting_RKWard.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/installing_starting_RKWard.tex	2010-12-27 06:09:26 UTC (rev 3329)
+++ branches/jss_dec_10/FINAL_JSS_TEX/installing_starting_RKWard.tex	2010-12-27 14:30:10 UTC (rev 3330)
@@ -1,14 +1,14 @@
 \section{Installing and starting RKWard}
 \label{sec:installing_starting_RKWard}
-RKWard can be downloaded free of charge in source and binary form\footnote{\url{http://rkward.sourceforge.net/}}. 
+RKWard can be downloaded free of charge in source and binary form from \url{http://rkward.sourceforge.net/}. 
 On the GNU/Linux platform, binary packages are available for many major distributions,
 including Debian, Ubuntu, OpenSuse, Gentoo, and Fedora. On the MS Windows
-platform, RKWard is available in two forms\footnote{For detailed information please refere to the 
-RKWard wiki \url{http://sourceforge.net/apps/mediawiki/rkward/index.php?title=Main_Page}.}: as a single binary
+platform, RKWard is available in two forms: as a single binary
 installer (requires existing installations of
 \proglang{R} and \proglang{KDE}) and
 as an installation bundle (including \proglang{R} and
-essential parts of the \proglang{KDE} SC). At the time of
+essential parts of the \proglang{KDE} SC)\footnote{For detailed information please refer to the 
+RKWard wiki \url{http://sourceforge.net/apps/mediawiki/rkward/index.php?title=Main_Page}.}. At the time of
 this writing, the developers lack the resources to support a MacOS X
 port, and especially to provide binaries for MacOS X. However, RKWard
 has been shown to be compilable and installable on the Mac, and appears
@@ -21,4 +21,4 @@
 workspace, to start with an empty workspace, or to create a new
 \code{data.frame} and open that for editing. Also, an overview help page is
 shown in the document area of the main window. Both start-up features
-can be turned off.
\ No newline at end of file
+can be turned off.

Modified: branches/jss_dec_10/FINAL_JSS_TEX/technical.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/technical.tex	2010-12-27 06:09:26 UTC (rev 3329)
+++ branches/jss_dec_10/FINAL_JSS_TEX/technical.tex	2010-12-27 14:30:10 UTC (rev 3330)
@@ -1,4 +1,4 @@
-\section{Technical Design}
+\section{Technical design}
 \label{sec:technical}
 In this section we will give a compact overview over key aspects of RKWards
 technical design. We will give slightly more attention to the details of the
@@ -338,7 +338,7 @@
 (see Section~\ref{sec:package_management}).
 
 RKWard avoids loading all these packages pro-actively, as \pkg{Rcmdr} does. Rather,
-plugins which depend on certain package simply include an appropriate call to
+plugins which depend on a certain package simply include an appropriate call to
 \code{require()} in the pre-processing section of the generated \proglang{R} code. The \code{require()}
 function is overloaded in RKWard, in order to bring up the package-installation
 dialog whenever needed. Packages invoked by \code{require()} remain loaded unless
@@ -388,9 +388,9 @@
 (\url{http://i18n.kde.org/tools/}). 
 
 Plugins and help pages in RKWard are not translatable at the time of this
-writing. While it will be technically to include the respective strings in
+writing. While it will be technically possible to include the respective strings in
 message catalogs, this is not currently implemented in RKWard. Similarly, any
 output generated by \proglang{R} functions defined for RKWard is not currently
 translatable. Again, however, there is no technical barrier with respect to
-internationalizing of \proglang{R} code, as discussed by \cite{Ripley2005a},
+internationalization of \proglang{R} code, as discussed by \cite{Ripley2005a},
 and it is planned to make RKWard fully translatable in future versions.


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