[rkward-cvs] SF.net SVN: rkward: [1992] trunk/rkward/rkward/pages
tfry at users.sourceforge.net
tfry at users.sourceforge.net
Tue Sep 25 10:17:39 UTC 2007
Revision: 1992
http://rkward.svn.sourceforge.net/rkward/?rev=1992&view=rev
Author: tfry
Date: 2007-09-25 03:17:39 -0700 (Tue, 25 Sep 2007)
Log Message:
-----------
Add help page on workspace browser
Modified Paths:
--------------
trunk/rkward/rkward/pages/Makefile.am
trunk/rkward/rkward/pages/rkward_console.rkh
trunk/rkward/rkward/pages/rkward_for_new_users.rkh
trunk/rkward/rkward/pages/rkward_for_r_users.rkh
Added Paths:
-----------
trunk/rkward/rkward/pages/rkward_workspace_browser.rkh
Modified: trunk/rkward/rkward/pages/Makefile.am
===================================================================
--- trunk/rkward/rkward/pages/Makefile.am 2007-09-24 23:00:09 UTC (rev 1991)
+++ trunk/rkward/rkward/pages/Makefile.am 2007-09-25 10:17:39 UTC (rev 1992)
@@ -7,5 +7,6 @@
rkward_help.css \
rkward_shortcuts.rkh \
rkward_trouble_shooting.rkh \
- rkward_output.rkh
+ rkward_output.rkh \
+ rkward_workspace_browser.rkh
Modified: trunk/rkward/rkward/pages/rkward_console.rkh
===================================================================
--- trunk/rkward/rkward/pages/rkward_console.rkh 2007-09-24 23:00:09 UTC (rev 1991)
+++ trunk/rkward/rkward/pages/rkward_console.rkh 2007-09-25 10:17:39 UTC (rev 1992)
@@ -59,6 +59,7 @@
<li><b>Maximum length command history</b>: Only this many lines are kept in the <link href="#command_history">command history</link>.</li>
<li><b>Maximum number of paragraphs/lines to display in the console</b>: No more than this many total lines (commands and output) will be shown in the console. When this number of lines is exceeded, lines will be removed at the top of the console window. To clear the console entirely, chose "Clear" from the context menu or the Edit menu.</li>
<li><b>Run commands from script editor throught the console</b>: Commands coming from script editors may be sent through the console, i.e. the commands and their results will be shown in the console. If this option is not checked, the commands will only be visible in the Command log, but not in the console.</li>
+ <li><b>Also add those commands to console history</b>: If the above option is checked, this affects, whether such commands are also added to the console history. Turning off this option may help to keep the console history "clean".</li>
<li><b>Command history is context sensitive by default</b>: If this is checked, the context sensitive mode of navigating the <link href="#command_history">command history</link> is the default, i.e. available with Up/Down without Shift. Else the key binding for this is Shift+Up/Down.</li>
</ul>
</section>
Modified: trunk/rkward/rkward/pages/rkward_for_new_users.rkh
===================================================================
--- trunk/rkward/rkward/pages/rkward_for_new_users.rkh 2007-09-24 23:00:09 UTC (rev 1991)
+++ trunk/rkward/rkward/pages/rkward_for_new_users.rkh 2007-09-25 10:17:39 UTC (rev 1992)
@@ -11,7 +11,7 @@
R - and hence RKWard - can deal with a large number of different types of data: The well known spreadsheets, but also single vectors of data (like a column in a spreadsheet), so called "list"s of different vectors or other objects that may have different lengths, single data points, etc. Even most of the language itself, the functions, are stored just like data and can also be edited.
-At the same time, R is not confined to working with just one piece of data at a time, but rather you have a "Workspace", where all your different variables, tables, etc. are accessible. You can have many data.frames at once, and additional data of other types. At the left side of the application window, there should be an icon labelled "Workspace". You can click on this to see all the objects present in your workspace. All the objects you create or modify will be visible inside the ".GlobalEnv". Most other objects are predefined in libraries, such as "package:base".
+At the same time, R is not confined to working with just one piece of data at a time, but rather you have a "Workspace", where all your different variables, tables, etc. are accessible. You can have many data.frames at once, and additional data of other types. At the left side of the application window, there should be an icon labelled "Workspace". You can click on this to see all the objects present in your workspace. All the objects you create or modify will be visible inside the ".GlobalEnv". Most other objects are predefined in libraries, such as "package:base". See <link href="rkward://page/rkward_workspace_browser"/> for details.
You do not need to worry about all these details. To create a new spreadsheet (data.frame), chose File->New->Dataset from the menu. All you need to do is to assign a name to this table, then you can start editing. To work with pre-existing data, chose File->Import->Load data, to load data in CSV (comma separated value) format.
</section>
@@ -42,6 +42,7 @@
<li><link href="rkward://page/rkward_shortcuts"/></li>
<li><link href="rkward://page/rkward_trouble_shooting"/></li>
<li><link href="rkward://page/rkward_output"/></li>
+ <li><link href="rkward://page/rkward_workspace_browser"/></li>
</ul>
</related>
</document>
Modified: trunk/rkward/rkward/pages/rkward_for_r_users.rkh
===================================================================
--- trunk/rkward/rkward/pages/rkward_for_r_users.rkh 2007-09-24 23:00:09 UTC (rev 1991)
+++ trunk/rkward/rkward/pages/rkward_for_r_users.rkh 2007-09-25 10:17:39 UTC (rev 1992)
@@ -28,7 +28,7 @@
<section title="Workspace View" id="workspace_browser">
RKWard comes with a "workspace view" or "object browser". By default this is available by clicking on "Workspace" on the left side of the application window. This allows you to examine and manipulate all objects in the R workspace. In case you are not familiar with this aspect of R (usually not directly visible): All the symbols you create are children of the so-called ".GlobalEnv" environment (see <link href="rkward://rhelp/.GlobalEnv"/>). Symbols defined in loaded libraries are located in their own environments.
- The object browser provides function to select with types of object are shown (on the top). Hovering the mouse over an item will show some additional information on the symbol. Right-clicking on an item will show available actions.
+ The object browser provides function to select with types of object are shown (on the top). Hovering the mouse over an item will show some additional information on the symbol. Right-clicking on an item will show available actions. See <link href="rkward://page/rkward_workspace_browser"/> for details.
</section>
<section title="R Help" id="rhelp">
By default R help pages are shown as HTML, inside RKWard. You can invoke the help in the usual way by running e.g. "?print" or "help (print)" or "help.start ()" in the console. Additionally, there is a tool window to search your installed R help pages. This is accessible using a button located at the bottom of the window (next to the console button). To view a help page found using this tool, double click on it.
@@ -56,6 +56,8 @@
<related>
<ul>
+ <li><link href="rkward://page/rkward_workspace_browser"/></li>
+ <li><link href="rkward://page/rkward_console"/></li>
<li><link href="rkward://page/rkward_for_new_users"/> For an introduction to some more basic concepts</li>
<li><link href="rkward://page/rkward_shortcuts"/></li>
</ul>
Added: trunk/rkward/rkward/pages/rkward_workspace_browser.rkh
===================================================================
--- trunk/rkward/rkward/pages/rkward_workspace_browser.rkh (rev 0)
+++ trunk/rkward/rkward/pages/rkward_workspace_browser.rkh 2007-09-25 10:17:39 UTC (rev 1992)
@@ -0,0 +1,41 @@
+<!DOCTYPE rkhelp>
+<document>
+ <title>Workspace Browser</title>
+
+ <summary>
+ The workspace browser allows to view and manipulate R objects. This includes both your own objects (data, functions), and so-called "package environments". As a rough analogy, this is similar to a regular file-system browser, expect you browser R objects in your workspace, instead of files on your computer.
+
+ The workspace browser can be invoked using Windows->Activate->Show / Hide Workspace Browser (default shortcut is Alt+1), or by clicking on the "Workspace" icon, which is located on the top of the left window border, by default.
+ </summary>
+
+ <section title="What is shown" id="introduction">
+ Literally hundreds or even thousands of objects are present in a typical R session. This can be overwhelming at first, therefore the workspace browser offers to show only a certain subset of objects. The options here are "Show Hidden Objects", "All vs. Non-Functions vs. Functions", and "Show All Environments" (available at the top of the browser window, or chosing "Show Objects" from the context menu).
+
+ The first should be obvious. It controls whether objects whose name start with a dot ('.') are shown or not. Those are often used for internal objects, which are not meant for direct use, so it's generally safe to hide them from view.
+
+ The second allows to select by the type of object. "All" does not filter, while "Functions" shows only functions, and "Non-Functions" shows all other objects (typically data).
+
+ The "Show All Environments" option controls, whether package environments and their objects are shown. Roughly speaking, if you turn off this option, only your "own" objects are shown, while with the option turned on, all pre-defined objects are also shown. More technically speaking, when the option is turned off, only the .GlobalEnv (see <link href="rkward://rhelp/globalenv"/>) is shown, which is the environment, in which you create and edit your data.
+
+ Note that objects are organized in a hierarchy, i.e. some types of objects contain further "child" objects. This is indicated by a "+" symbol to the left of the object name. Clicking on this will expand the view to show all the children of the object.
+
+ Hovering the mouse pointer over an object will show a short summary of the objects' basic properties.
+ </section>
+
+ <section title="Available actions" id="actions">
+ Several actions are available from the context menu (by right-clicking on one of the objects), however some of these actions are only available for some types of objects. The most important actions for objects in package environments:
+
+ <ul>
+ <li><b>Search Help</b>: This will try to locate and show a relevant R help page on the object.</li>
+ <li><b>View</b>: Open a window with detailed information about the object. This will, among others, use the R commands <link href="rkward://rhelp/print">print</link> and <link href="rkward://rhelp/summary">summary</link> to show more information.</li>
+ <li><b>Copy to new symbol / Copy to .GlobalEnv</b>: In order to manipulate objects, you need to copy them to the .GlobalEnv. For instance, you could copy an object from the environment "package:datasets" into the .GlobalEnv, and in a second step, edit it.</li>
+ </ul>
+
+ Further actions available for objects in the .GlobalEnv:
+
+ <ul>
+ <li><b>Edit</b>: Open the object in a data editor. Currently editing is only supported for data.frames.</li>
+ <li><b>Rename / Delete</b>: These should be obvious.</li>
+ </ul>
+ </section>
+</document>
\ 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