r/org.eclipse.statet.r.doc/reference/r_console-page.xhtml - statet/org.eclipse.statet-r - Git at Google

 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 	<meta http-equiv="Content-Style-Type" content="text/css"/>
 	<link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css"/>
 	<title>R Console (Page/View)</title>
 	<meta name="copyright" content="Copyright (c) 2008, 2019 Stephan Wahlbrink and others.  SPDX-License-Identifier: EPL-2.0 OR Apache-2.0"/>
 </head>
 <body>

 <h1>R Console (Page)</h1>

 <p>The R console is displayed as page in the <a href="console_view.xhtml">Console View</a> of the
 Eclipse IDE.</p>

 <img style="width: 819px; height: 271px;" alt="Screenshot console button" src="../images/screenshot_console_button.png"/>

 <p>The R console page is separated in two areas: the input line and the output viewer.
 The input line allows you to submit directly input to the launched tool.  The output viewer shows
 all submitted input and their &ldquo;response&rdquo;, the output of R.</p>


 <h2 id="input">Cmd Input</h2>
 <p>You can type commands in input line text field and edit code almost like in a usual editor of
 StatET.
 Pressing <kbd>ENTER</kbd> or the 'Submit'-Button sends your current input to your tool.</p>

 <h4>Special shortcuts</h4>
 <p>There are some special actions and keyboard shortcuts to access the command history and to
 scroll the output viewer, if you are in the input line:</p>
 <table class="style1">

 <thead><tr>
 	<th>Description</th>
 	<th>Availability</th>
 </tr></thead>
 <tr><th colspan="2">History control</th></tr><tr>
 	<td>Go to the following older history item</td>
 	<td><kbd>Up</kbd></td>
 </tr><tr>
 	<td>Go to the following newer history item</td>
 	<td><kbd>Down</kbd></td>
 </tr><tr>
 	<td>Go to the newest history item (last input)</td>
 	<td>Local&nbsp;command<br/>
 		<kbd>Ctrl+Alt+End</kbd></td>
 </tr><tr>
 	<td>Search for the following older history item starting with the text before the cursor.</td>
 	<td>Local&nbsp;command<br/>
 		<kbd>Ctrl+Alt+Up</kbd></td>
 </tr><tr>
 	<td>Search for the following newer history item starting with the text before the cursor.</td>
 	<td>Local&nbsp;command<br/>
 		<kbd>Ctrl+Alt+Down</kbd></td>
 </tr><tr>
 	<td colspan="2"><em>Tip:</em> You can use the Undo feature to go back to the last edited input.</td>
 </tr>

 <tr><th colspan="2"><a href="#output">Output</a> control</th></tr>
 <tr>
 	<td>Scroll output one line up</td>
 	<td><kbd>Shift+Up</kbd></td>
 </tr><tr>
 	<td>Scroll output one line down</td>
 	<td><kbd>Shift+Down</kbd></td>
 </tr><tr>
 	<td>Scroll output one page up</td>
 	<td><kbd>Shift+PageUp</kbd></td>
 </tr><tr>
 	<td>Scroll output one page down.</td>
 	<td><kbd>Shift+PageDown</kbd></td>
 </tr><tr>
 	<td>Scroll output to the start</td>
 	<td>
 <kbd>Shift+Ctrl+Home<enablement><not><systemTest property="osgi.os" value="macosx"/></not></enablement></kbd>
 <kbd>Shift+Command+Home<enablement><systemTest property="osgi.os" value="macosx"/></enablement></kbd>
 	</td>
 </tr><tr>
 	<td>Scroll output to the end</td>
 	<td>
 <kbd>Shift+Ctrl+End<enablement><not><systemTest property="osgi.os" value="macosx"/></not></enablement></kbd>
 <kbd>Shift+Command+End<enablement><systemTest property="osgi.os" value="macosx"/></enablement></kbd>
 	</td>
 </tr>
 </table>


 <p>
 The commands to include for the history navigation can be configured in the preferences; by default
 only commands directly from the console are enabled.</p>

 <h4>Content Assistant</h4>
 <p>
 See <a href="r_editor-contentassist.xhtml">Content Assistant</a> of R editor.</p>
 <p>
 For remote consoles, the completion of resource paths requires the configuration of
 <a href="r_remote_console-resourcemapping.xhtml">resource mappings</a>.</p>

 <h2 id="output">Console Output</h2>
 <ul>
 	<li>Coloring of errors</li>
 	<li>Links to line in script when submitting from script</li>
 </ul>


 <h2>Actions of the R Console</h2>
 <p>As any other view, the Console view offers a toolbar with buttons and menus that allow
 straightforward interaction&nbsp;and configuration, as well as the view menu in the right corner of
 that toolbar.</p>
 <p>See also: <a href="console_view.xhtml#actions">Console View</a>.</p>

 <table class="style1">
 <thead><tr>
 	<th></th>
 	<th>Name</th>
 	<th>Description</th>
 	<th>Availability</th>
 </tr></thead>
 <tr>
 	<td><img alt="Icon" src="../icons/loctool/cancel.png" style="vertical-align: text-top"/></td>
 	<td><span class="uilabel">Cancel Task</span></td>
 	<td><p>Cancel Tasks is a menu that allows to cancel the execution of the currently running
 		R task. This can be useful e.g. when one launches an intensive simulation, but discovers
 		the parameters were not correctly specified. The menu offers three options.</p>
 		<img style="width: 321px; height: 111px;" alt="Screenshot full cancel tasks menu"
 				src="../images/screenshot_full_cancel_tasks_menu.png"/>
 		<p>The first one is
 		also used when pressing the button directly and assigned to the default keyboard shortcuts.</p>
 	</td>
 	<td>View&nbsp;toolbar<br/>
 		Global&nbsp;command<br/>
 		<kbd>Ctrl+Break</kbd><br/>
 		<kbd>Break</kbd></td>
 </tr>
 <tr>
 	<td><img alt="Icon" src="../icons/loctool/terminate.gif" style="vertical-align: text-top"/></td>
 	<td><span class="uilabel">Terminate</span></td>
 	<td><p>The Stop Console button allows to quit a given R. On pressing this button, the user will
 		be prompted to save the workspace or not (can be disabled by launch arguments).</p>
 		<img style="width: 679px; height: 394px;" alt="Screenshot terminate action" src="../images/screenshot_terminate_action.png"/>
 	</td>
 	<td>View&nbsp;toolbar</td>
 </tr>
 <tr>
 	<td><img alt="Icon" src="../icons/tool/paste.gif" style="vertical-align: text-top"/></td>
 	<td><span class="uilabel">Paste</span> /<br/>
 		<span class="uilabel">Paste/Submit</span> /<br/>
 		<span class="uilabel">Drop</span></td>
 	<td><p>The paste command for the input field works as usual; it inserts the text from the
 		clipboard at the selected position.  The text can be edited before submitting the code to
 		R.</p>
 		<p>If the output area is active (e.g. using its context menu), the paste command submits
 		the text from the clipboard to R directly.  The current text in the input field is not
 		changed.</p>
 		<p>When dragging text using the mouse, dropping the text into the R console acts like the
 		paste command to the input / output area described above.</p>
 	</td>
 	<td>Main&nbsp;menu (Edit)<br/>
 		Context&nbsp;menu<br/>
 		Local&nbsp;command<br/>
 		<kbd>CTRL+V</kbd><br/>
 		Drag&nbsp;&amp;&nbsp;Drop
 	</td>
 </tr>
 <tr><th colspan="4">Output</th></tr>
 <tr>
 	<td><img alt="Icon" src="../icons/loctool/clear_output.gif" style="vertical-align: text-top"/></td>
 	<td><span class="uilabel">Clear Console</span> /<br/>
 		<span class="uilabel">Clear Console Output</span></td>
 	<td><p>The Clear command will clean the output window of the console.  After clearing the
 		console, it obviously is no longer possible to scroll up to previous output.</p></td>
 	<td>View&nbsp;toolbar<br/>
 		Context&nbsp;menu (Output)<br/>
 		Global&nbsp;command<br/>
 		<kbd>Ctrl+L</kbd><br/>
 		<kbd>Ctrl+R L</kbd></td>
 </tr>
 <tr>
 	<td><img alt="Icon" src="../icons/loctool/scrolllock.gif" style="vertical-align: text-top"/></td>
 	<td><span class="uilabel">Scroll-Lock</span></td>
 	<td><p>The Scroll-Lock button is a toggle button that allows to lock scrolling of the console
 		output window.  This implies that when submitting new statements either at the command line
 		or from a script, the view the user has on the output window will not change.  It is, of
 		course, always possible to manually scroll to a given location within the output window.</p></td>
 	<td>View&nbsp;toolbar<br/>
 		Context&nbsp;menu (Output)</td>
 </tr>
 <tr>
 	<td></td>
 	<td><span class="uilabel">Adjust Output Width</span> /<br/>
 		<span class="uilabel">Adjust Console Output Width</span></td>
 	<td><p>This menu item will change the number of characters of an R output line, such that it
 		perfectly fits the current dimensions of the R Console View.  The function adapts the R
 		option <code>width</code> (see R help of 'options').</p></td>
 	<td>Context&nbsp;menu (Output)<br/>
 		Global&nbsp;command</td>
 </tr>
 <!-- Export Console Output -->
 </table>

 <!-- Not related to the console page -->
 <h4>Change Working Directory</h4>
 <p>This menu item allows to change the R working directory of the console via
 an Eclipse interface.</p>


 </body>
 </html>
	<?xml version="1.0" encoding="UTF-8"?>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
	<meta http-equiv="Content-Style-Type" content="text/css"/>
	<link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css"/>
	<title>R Console (Page/View)</title>
	<meta name="copyright" content="Copyright (c) 2008, 2019 Stephan Wahlbrink and others. SPDX-License-Identifier: EPL-2.0 OR Apache-2.0"/>
	</head>
	<body>

	<h1>R Console (Page)</h1>

	<p>The R console is displayed as page in the <a href="console_view.xhtml">Console View</a> of the
	Eclipse IDE.</p>

	<img style="width: 819px; height: 271px;" alt="Screenshot console button" src="../images/screenshot_console_button.png"/>

	<p>The R console page is separated in two areas: the input line and the output viewer.
	The input line allows you to submit directly input to the launched tool. The output viewer shows
	all submitted input and their “response”, the output of R.</p>


	<h2 id="input">Cmd Input</h2>
	<p>You can type commands in input line text field and edit code almost like in a usual editor of
	StatET.
	Pressing <kbd>ENTER</kbd> or the 'Submit'-Button sends your current input to your tool.</p>

	<h4>Special shortcuts</h4>
	<p>There are some special actions and keyboard shortcuts to access the command history and to
	scroll the output viewer, if you are in the input line:</p>
	<table class="style1">

	<thead><tr>
	<th>Description</th>
	<th>Availability</th>
	</tr></thead>
	<tr><th colspan="2">History control</th></tr><tr>
	<td>Go to the following older history item</td>
	<td><kbd>Up</kbd></td>
	</tr><tr>
	<td>Go to the following newer history item</td>
	<td><kbd>Down</kbd></td>
	</tr><tr>
	<td>Go to the newest history item (last input)</td>
	<td>Local command<br/>
	<kbd>Ctrl+Alt+End</kbd></td>
	</tr><tr>
	<td>Search for the following older history item starting with the text before the cursor.</td>
	<td>Local command<br/>
	<kbd>Ctrl+Alt+Up</kbd></td>
	</tr><tr>
	<td>Search for the following newer history item starting with the text before the cursor.</td>
	<td>Local command<br/>
	<kbd>Ctrl+Alt+Down</kbd></td>
	</tr><tr>
	<td colspan="2"><em>Tip:</em> You can use the Undo feature to go back to the last edited input.</td>
	</tr>

	<tr><th colspan="2"><a href="#output">Output</a> control</th></tr>
	<tr>
	<td>Scroll output one line up</td>
	<td><kbd>Shift+Up</kbd></td>
	</tr><tr>
	<td>Scroll output one line down</td>
	<td><kbd>Shift+Down</kbd></td>
	</tr><tr>
	<td>Scroll output one page up</td>
	<td><kbd>Shift+PageUp</kbd></td>
	</tr><tr>
	<td>Scroll output one page down.</td>
	<td><kbd>Shift+PageDown</kbd></td>
	</tr><tr>
	<td>Scroll output to the start</td>
	<td>
	<kbd>Shift+Ctrl+Home<enablement><not><systemTest property="osgi.os" value="macosx"/></not></enablement></kbd>
	<kbd>Shift+Command+Home<enablement><systemTest property="osgi.os" value="macosx"/></enablement></kbd>
	</td>
	</tr><tr>
	<td>Scroll output to the end</td>
	<td>
	<kbd>Shift+Ctrl+End<enablement><not><systemTest property="osgi.os" value="macosx"/></not></enablement></kbd>
	<kbd>Shift+Command+End<enablement><systemTest property="osgi.os" value="macosx"/></enablement></kbd>
	</td>
	</tr>
	</table>


	<p>
	The commands to include for the history navigation can be configured in the preferences; by default
	only commands directly from the console are enabled.</p>

	<h4>Content Assistant</h4>
	<p>
	See <a href="r_editor-contentassist.xhtml">Content Assistant</a> of R editor.</p>
	<p>
	For remote consoles, the completion of resource paths requires the configuration of
	<a href="r_remote_console-resourcemapping.xhtml">resource mappings</a>.</p>

	<h2 id="output">Console Output</h2>
	<ul>
	<li>Coloring of errors</li>
	<li>Links to line in script when submitting from script</li>
	</ul>


	<h2>Actions of the R Console</h2>
	<p>As any other view, the Console view offers a toolbar with buttons and menus that allow
	straightforward interaction and configuration, as well as the view menu in the right corner of
	that toolbar.</p>
	<p>See also: <a href="console_view.xhtml#actions">Console View</a>.</p>

	<table class="style1">
	<thead><tr>
	<th></th>
	<th>Name</th>
	<th>Description</th>
	<th>Availability</th>
	</tr></thead>
	<tr>
	<td><img alt="Icon" src="../icons/loctool/cancel.png" style="vertical-align: text-top"/></td>
	<td><span class="uilabel">Cancel Task</span></td>
	<td><p>Cancel Tasks is a menu that allows to cancel the execution of the currently running
	R task. This can be useful e.g. when one launches an intensive simulation, but discovers
	the parameters were not correctly specified. The menu offers three options.</p>
	<img style="width: 321px; height: 111px;" alt="Screenshot full cancel tasks menu"
	src="../images/screenshot_full_cancel_tasks_menu.png"/>
	<p>The first one is
	also used when pressing the button directly and assigned to the default keyboard shortcuts.</p>
	</td>
	<td>View toolbar<br/>
	Global command<br/>
	<kbd>Ctrl+Break</kbd><br/>
	<kbd>Break</kbd></td>
	</tr>
	<tr>
	<td><img alt="Icon" src="../icons/loctool/terminate.gif" style="vertical-align: text-top"/></td>
	<td><span class="uilabel">Terminate</span></td>
	<td><p>The Stop Console button allows to quit a given R. On pressing this button, the user will
	be prompted to save the workspace or not (can be disabled by launch arguments).</p>
	<img style="width: 679px; height: 394px;" alt="Screenshot terminate action" src="../images/screenshot_terminate_action.png"/>
	</td>
	<td>View toolbar</td>
	</tr>
	<tr>
	<td><img alt="Icon" src="../icons/tool/paste.gif" style="vertical-align: text-top"/></td>
	<td><span class="uilabel">Paste</span> /<br/>
	<span class="uilabel">Paste/Submit</span> /<br/>
	<span class="uilabel">Drop</span></td>
	<td><p>The paste command for the input field works as usual; it inserts the text from the
	clipboard at the selected position. The text can be edited before submitting the code to
	R.</p>
	<p>If the output area is active (e.g. using its context menu), the paste command submits
	the text from the clipboard to R directly. The current text in the input field is not
	changed.</p>
	<p>When dragging text using the mouse, dropping the text into the R console acts like the
	paste command to the input / output area described above.</p>
	</td>
	<td>Main menu (Edit)<br/>
	Context menu<br/>
	Local command<br/>
	<kbd>CTRL+V</kbd><br/>
	Drag & Drop
	</td>
	</tr>
	<tr><th colspan="4">Output</th></tr>
	<tr>
	<td><img alt="Icon" src="../icons/loctool/clear_output.gif" style="vertical-align: text-top"/></td>
	<td><span class="uilabel">Clear Console</span> /<br/>
	<span class="uilabel">Clear Console Output</span></td>
	<td><p>The Clear command will clean the output window of the console. After clearing the
	console, it obviously is no longer possible to scroll up to previous output.</p></td>
	<td>View toolbar<br/>
	Context menu (Output)<br/>
	Global command<br/>
	<kbd>Ctrl+L</kbd><br/>
	<kbd>Ctrl+R L</kbd></td>
	</tr>
	<tr>
	<td><img alt="Icon" src="../icons/loctool/scrolllock.gif" style="vertical-align: text-top"/></td>
	<td><span class="uilabel">Scroll-Lock</span></td>
	<td><p>The Scroll-Lock button is a toggle button that allows to lock scrolling of the console
	output window. This implies that when submitting new statements either at the command line
	or from a script, the view the user has on the output window will not change. It is, of
	course, always possible to manually scroll to a given location within the output window.</p></td>
	<td>View toolbar<br/>
	Context menu (Output)</td>
	</tr>
	<tr>
	<td></td>
	<td><span class="uilabel">Adjust Output Width</span> /<br/>
	<span class="uilabel">Adjust Console Output Width</span></td>
	<td><p>This menu item will change the number of characters of an R output line, such that it
	perfectly fits the current dimensions of the R Console View. The function adapts the R
	option <code>width</code> (see R help of 'options').</p></td>
	<td>Context menu (Output)<br/>
	Global command</td>
	</tr>
	<!-- Export Console Output -->
	</table>

	<!-- Not related to the console page -->
	<h4>Change Working Directory</h4>
	<p>This menu item allows to change the R working directory of the console via
	an Eclipse interface.</p>


	</body>
	</html>