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

sjar at users.sourceforge.net sjar at users.sourceforge.net
Sun Dec 19 22:19:28 UTC 2010


Revision: 3270
          http://rkward.svn.sourceforge.net/rkward/?rev=3270&view=rev
Author:   sjar
Date:     2010-12-19 22:19:27 +0000 (Sun, 19 Dec 2010)

Log Message:
-----------


Modified Paths:
--------------
    branches/jss_dec_10/FINAL_JSS_TEX/RKWard_paper.tex

Added Paths:
-----------
    branches/jss_dec_10/FINAL_JSS_TEX/conclusion_summary_acknowledgments.tex
    branches/jss_dec_10/FINAL_JSS_TEX/example_session.tex
    branches/jss_dec_10/FINAL_JSS_TEX/installing_starting_RKWard.tex

Modified: branches/jss_dec_10/FINAL_JSS_TEX/RKWard_paper.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/RKWard_paper.tex	2010-12-19 22:15:51 UTC (rev 3269)
+++ branches/jss_dec_10/FINAL_JSS_TEX/RKWard_paper.tex	2010-12-19 22:19:27 UTC (rev 3270)
@@ -17,7 +17,7 @@
 
 %% an abstract and keywords
 \Abstract{
-  R is a free, open-source implementation of the S statistical computing
+  R is a free, open-source implementation of the  \proglang{S} statistical computing
 language and programming environment. The current status of R is a
 command line driven interface with no advanced standard Graphical User
 Interface (GUI) but it includes tools for building such. Over the past
@@ -25,17 +25,17 @@
 or external tool kits, with different scopes and technological concepts
 have emerged. In this paper we discuss RKWard which aims to be both a
 comprehensive cross-platform GUI and Integrated Development Environment
-(IDE) for R. RKWard is based on the KDE software libraries. Statistical
+(IDE) for \proglang{R}. RKWard is based on the \proglang{KDE} software libraries. Statistical
 procedures and plots are implemented using an extendable plugin
-architecture based on ECMA script (JavaScript), R, and XML. RKWard
+architecture based on \proglang{ECMAScript} (\proglang{JavaScript}), \proglang{R}, and \proglang{XML}. RKWard
 provides an excellent tool to manage different types of data objects;
 even allowing for seamless editing of certain types. The objective of
-RKWard is to provide a portable and extensible R interface for both
+RKWard is to provide a portable and extensible \proglang{R} interface for both
 basic and advanced statistical and graphical analysis while not
-compromising on flexibility and modularity of the R programming
+compromising on flexibility and modularity of the \proglang{R} programming
 environment itself.
 }
-\Keywords{GUI, IDE, R, plugin, cross-platform}
+\Keywords{GUI, IDE, \proglang{R}, plugin, cross-platform}
 \Plainkeywords{keywords, comma-separated, not capitalized, Java} %% without formatting
 %% at least one keyword must be supplied
 
@@ -100,8 +100,10 @@
 \include{background}
 %%\include{usage}
 \include{technical}
-%%\include{example_session}
+\include{example_session}
 \include{example_plugin}
+\include{installing_starting_RKWard}
+\include{conclusion_summary_acknowledgments}
 
 \bibliography{sources}
 \end{document}

Added: branches/jss_dec_10/FINAL_JSS_TEX/conclusion_summary_acknowledgments.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/conclusion_summary_acknowledgments.tex	                        (rev 0)
+++ branches/jss_dec_10/FINAL_JSS_TEX/conclusion_summary_acknowledgments.tex	2010-12-19 22:19:27 UTC (rev 3270)
@@ -0,0 +1,22 @@
+\section{Conclusion and Summary}
+Within this work we introduced RKWard which is both an IDE for
+\proglang{R} scripts and a GUI to statistical
+procedures commonly used in the process of statistical analysis.
+
+\begin{enumerate}
+\item For Desktop
+\item Conservative GUI other than data-flow programming (ViSta (called
+WorkMap, Young 2004, 2005 (JSS), Red-R or Statistiklabor)
+\item Customizable for User needs
+\item Further development (GHNS) of plugins for extension of RKWards
+functionality
+\item We do not focus on \proglang{R} package
+development but keep it at the \proglang{R} community.
+However, scripts which are routinely in use or require complex steps
+can be converted to GUI elements in RKWard.
+\item Plugin structure independent development (not compatible with
+other \proglang{R} GUI solutions)
+\end{enumerate}
+\section{Acknowledgments}
+The work described in this paper was supported by YOUR NAME OR THE NAME
+OF SOMEBODELSE HERE
\ No newline at end of file

Added: branches/jss_dec_10/FINAL_JSS_TEX/example_session.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/example_session.tex	                        (rev 0)
+++ branches/jss_dec_10/FINAL_JSS_TEX/example_session.tex	2010-12-19 22:19:27 UTC (rev 3270)
@@ -0,0 +1,81 @@
+\section{Using RKWard- An example RKWard session}
+\label{sec:using_RKWard}
+To see how RKWard works in practice an example session is described.
+This might be a routinely used procedure on changing data stets or
+\proglang{R} scripts which are complex and therfore
+more conveniently used guided manner. We assume that an experimental
+treatment was given to 20 test subjects and the values of the dependent
+variable before and after the treatment should be compared. 
+
+\subsection{Importing Data}
+\label{sec:importing_data}
+The data was saved as or exported to CSV format for example from a
+spread sheet application. RKWards import plugin can
+comfortably read it into a new \proglang{R} object.
+The import dialog ("File->Import->Import
+format->Import Text / CSV data") assists during the
+selection of the data by a common point and click interface (Figure~\ref{fig:import_data}A). Within our
+example "comma" and "period" were chosen via "Quick mode" as field
+separator character and decimal point character respectively. RKWard
+also takes care of name conflicts in the .GlobalEnv or suggests to
+overwrite or use another name.
+
+\code{read.csv(file=/media/software/experiment.txt, 
+na.strings = NA, nrows = -1, skip = 0,
+check.names = TRUE, strip.white = FALSE, blank.lines.skip = TRUE)}
+
+Checking the "Edit Object" box will automatically open a data editor tab
+showing the imported data (Figure~\ref{fig:import_data}B).
+
+\begin{figure}[htp]
+ \centering
+ \includegraphics[clip=true,trim=0cm 5.7cm 0cm 5.7cm,width=16cm]{../figures/import_data.pdf}
+ \caption{A) RKWard provides useful defaults
+to import widely used data formats, including SPSS and Stata files. As
+a common example the import of CSV data was chosen. B) Data editor. The imported CSV
+data from experiment.txt are presented (data visually trimmed).}
+ \label{fig:import_data}
+\end{figure}
+
+\subsection{Conducting a Students t-test}
+\label{sec:conducting_ttest}
+To test the hypothesis that the given treatment significantly increased
+the values of the dependent variable, a Students
+t-test for a paired sample is applied. In the variable slot on the left
+side you select the variables from the unfolded
+\proglang{R} object (Figure~\ref{fig:t_test}A).
+
+\begin{figure}[htp]
+ \centering
+ \includegraphics[clip=true,trim=0cm 5.7cm 0cm 5.7cm,width=16cm]{../figures/t-test.pdf}
+ \caption{A) Students t-test dialog for a two variables. B) Test results in \proglang{HTML} format.}
+ \label{fig:t_test}
+\end{figure}
+
+After the "Submit" button was pressed, RKWard opens the output document
+to show the results (Figure~\ref{fig:t_test}B).
+
+\subsection{Creating a Plot}
+\label{sec:create_plot}
+To visualize the test data, "Boxplot" is chosen from the "Plots" menu
+and variables selected like for the Students t-test.
+The dialog allows to define custom variable labels (Figure~\ref{fig:boxplot1}).
+
+Checking the "Preview" box will open a graphics window, show the plot as
+it is configured and update the window on changes in real time. From
+that window it can be exported directly to several data formats as
+well (Figure~\ref{fig:boxplot2}).
+
+\begin{figure}[htp]
+ \centering
+ \includegraphics[clip=true,width=16cm]{../figures/boxplot1.pdf}
+ \caption{Boxplot dialog.}
+ \label{fig:boxplot1}
+\end{figure}
+
+\begin{figure}[htp]
+ \centering
+ \includegraphics[clip=true,width=16cm]{../figures/boxplot2.pdf}
+ \caption{Plotted data and plot export dialog.}
+ \label{fig:boxplot2}
+\end{figure}

Added: branches/jss_dec_10/FINAL_JSS_TEX/installing_starting_RKWard.tex
===================================================================
--- branches/jss_dec_10/FINAL_JSS_TEX/installing_starting_RKWard.tex	                        (rev 0)
+++ branches/jss_dec_10/FINAL_JSS_TEX/installing_starting_RKWard.tex	2010-12-19 22:19:27 UTC (rev 3270)
@@ -0,0 +1,23 @@
+\section{Installing and Starting RKWard}
+RKWard can be downloaded free of charge in source and binary from
+\url{http://sourceforge.net/}. On the GNU/Linux
+platform, binary packages are available for many major distributions,
+including Debian, Ubuntu, OpenSuse, Gentoo, and Fedora. On the Windows
+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 \proglang{KDE} SC). 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
+to be mostly functional.
+
+RKWard cannot be loaded from within an \proglang{R}
+session, but rather it is started as a stand-alone application with an
+embedded \proglang{R} engine. To facilitate the first
+steps for new users, a dialog offers the choice to load an existing
+workspace, to start with an empty workspace, or to create a new
+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


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