'\" t .\" Title: \fBrkward\fR .\" Author: Thomas Friedrichsmeier .\" Generator: DocBook XSL Stylesheets vsnapshot .\" Date: 2017-05-20 .\" Manual: KDE User's Manual .\" Source: K Desktop Environment .\" Language: English .\" .TH "\FBRKWARD\FR" "1" "2017\-05\-20" "K Desktop Environment" "KDE User's Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" rkward \- A KDE frontend to R .SH "SYNOPSIS" .HP \w'\fBrkward\fR\ 'u \fBrkward\fR [\fB\-\-evaluate\fR\fI Rcode\fR] [\fB\-\-debug\-level\fR\fI level\fR] [\fB\-\-debug\-flags\fR\fI flags\fR] [\fB\-\-debug\-output\fR\fI where\fR] [\fB\-\-backend\-debugger\fR\fI debugger_command\fR] [\fB\-\-r\-executable\fR\fI path_to_executable\fR] [\fB\-\-reuse\fR] [\fB\-\-autoreuse\fR] [\fB\-\-nowarn\-external\fR] [KDE\ Generic\ Options] [Qt\ Generic\ Options] [\fIfiles_to_open\fR] .SH "DESCRIPTION" .PP RKWard is the a KDE\-based GUI and IDE for the R scripting language for statistical computing\&. .PP For more information, please refer to \m[blue]\fBthe RKWard website\fR\m[]\&\s-2\u[1]\d\s+2, and the documentation provided inside RKWard\&. .SH "OPTIONS" .PP \fB\-\-evaluate\fR \fIRcode\fR .RS 4 The given R code is evaluated after RKWard has started, and after any specified workspace is loaded\&. Mostly useful for automated testing\&. .RE .PP \fB\-\-debug\-level\fR \fIlevel\fR .RS 4 Verbosity of debug output\&. 0\-5, where 0 is no output, 5 is all output including function trace information\&. Default is 2\&. .RE .PP \fB\-\-debug\-output\fR \fIwhere\fR .RS 4 Where to send debug output\&. Default is to store it in a file in the temporary directory\&. Specifying "terminal" will write debug output to stderr, instead (useful for debugging startup problems)\&. Note that debug output from the backend process is always stored in a file\&. .RE .PP \fB\-\-debug\-flags\fR \fIflags\fR .RS 4 Configure which sections of code to debug\&. Flags are given as a binary number\&. Refer to the source files for documentation, as this really is an internal option\&. .RE .PP \fB\-\-backend\-debugger\fR \fIcommand\fR .RS 4 Run the RKWard backend through the specified debugger command\&. To add command line options to the debugger command, enclose them in single quotes (\*(Aq\*(Aq) together with the command\&. \fINOTE:\fR Debugger arguments will be split by spaces\&. If this is not appropriate, you will have to write your own wrapper script for invoking the debugger\&. Also, make sure to redirect all debugger output and/or input as appropriate\&. See the examples\&. .RE .PP \fB\-\-r\-executable\fR \fIcommand\fR .RS 4 In the case of several R installations, specify the installation to use, e\&.g\&. /usr/bin/R\&. You can also use the string \fI"auto"\fR, in which case RKWard will try to find R at one of the known standard installation paths\&. \fINOTE\fR that while RKWard will \fIoften\fR work with newer versions of R, it will \fIsometimes\fR need to be re\-compiled for that version, or it may be incompatible altogether\&. .RE .PP \fB\-\-reuse\fR .RS 4 If an instance of RKWard is already running, bring that to the front, and open \fIfiles_to_open\fR\&. Note that all other command line options will be ignored in case an instance is reused\&. .RE .PP \fB\-\-autoreuse\fR .RS 4 Behaves like \fB\-\-reuse\fR, if any file arguments are also given, starts a new instance, otherwise\&. Intended for use in the \&.desktop file\&. .RE .PP \fB\-\-nowarn\-external\fR .RS 4 Usually, when invoking RKWard plugins from the command line (i\&.e\&. when \fIfiles_to_open\fR contains URLs of the form \fIrkward://runplugin/\&.\&.\&.\fR), RKWard will show a warning that such URLs \fIcould\fR be used to trigger malicious actions on your system\&. This warning applies specifically to links found on untrusted websites, or other untrusted external sources\&. If you want to script RKWard locally, you can avoid this warning by adding \-\-nowarn\-external to the command line\&. .RE .PP \fIfiles_to_open\fR .RS 4 You can specify any number of file names or URLs for RKWard to open\&. Usually this will be either workspace files, workplace files, R script files, or rkward:// URLs (e\&.g\&. for starting with a plugin dialog)\&. Specifying more than one workspace file will lead to the workspaces being merged together, and is not recommended\&. .RE .SH "SEE ALSO" .PP \fBR\fR(1) .SH "EXAMPLES" .PP .if n \{\ .RS 4 .\} .nf # Start with the t\-test dialog rkward \-\-nowarn\-external rkward://runplugin/rkward::t_test/ # Open two script files in a running instance of RKWard (or in a fresh instance, if RKWard is not running) rkward \-\-reuse file_a\&.R file_b\&.R # Run the rkward backend through valgrind rkward \-\-backend\-debugger \*(Aqvalgrind \-\-log\-file=valgrind\&.log\*(Aq .fi .if n \{\ .RE .\} .SH "AUTHORS" .PP RKWard was written by Thomas Friedrichsmeier and the RKWard team\&. See \m[blue]\fBthe RKWard website\fR\m[]\&\s-2\u[1]\d\s+2\&. .SH "AUTHOR" .PP \fBThomas Friedrichsmeier\fR <\&rkward\-devel@kde\&.org\&> .RS 4 RKWard man page\&. .RE .SH "NOTES" .IP " 1." 4 the RKWard website .RS 4 \%https://rkward.kde.org/ .RE