1RKWARD(1) KDE User's Manual RKWARD(1)
2
6 rkward - A KDE frontend to R
7
9 rkward [--evaluate Rcode] [--debug-level level] [--debug-flags flags]
10 [--debug-output where] [--backend-debugger debugger_command]
11 [--r-executable path_to_executable] [--reuse] [--autoreuse]
12 [--nowarn-external] [KDE Generic Options] [Qt Generic Options]
13 [files_to_open]
14
16 RKWard is the a KDE-based GUI and IDE for the R scripting language for
17 statistical computing.
18 For more information, please refer to the RKWard website[1], and the
20 documentation provided inside RKWard.
21
23 --evaluate Rcode
24 The given R code is evaluated after RKWard has started, and after
25 any specified workspace is loaded. Mostly useful for automated
26 testing.
27 --debug-level level
29 Verbosity of debug output. 0-5, where 0 is no output, 5 is all
30 output including function trace information. Default is 2.
31 --debug-output where
33 Where to send debug output. Default is to store it in a file in the
34 temporary directory. Specifying "terminal" will write debug output
35 to stderr, instead (useful for debugging startup problems). Note
36 that debug output from the backend process is always stored in a
37 file.
38 --debug-flags flags
40 Configure which sections of code to debug. Flags are given as a
41 binary number. Refer to the source files for documentation, as this
42 really is an internal option.
43 --backend-debugger command
45 Run the RKWard backend through the specified debugger command. To
46 add command line options to the debugger command, enclose them in
47 single quotes ('') together with the command. NOTE: Debugger
48 arguments will be split by spaces. If this is not appropriate, you
49 will have to write your own wrapper script for invoking the
50 debugger. Also, make sure to redirect all debugger output and/or
51 input as appropriate. See the examples.
52 --r-executable command
54 In the case of several R installations, specify the installation to
55 use, e.g. /usr/bin/R. You can also use the string "auto", in which
56 case RKWard will try to find R at one of the known standard
57 installation paths. NOTE that while RKWard will often work with
58 newer versions of R, it will sometimes need to be re-compiled for
59 that version, or it may be incompatible altogether.
60 --reuse
62 If an instance of RKWard is already running, bring that to the
63 front, and open files_to_open. Note that all other command line
64 options will be ignored in case an instance is reused.
65 --autoreuse
67 Behaves like --reuse, if any file arguments are also given, starts
68 a new instance, otherwise. Intended for use in the .desktop file.
69 --nowarn-external
71 Usually, when invoking RKWard plugins from the command line (i.e.
72 when files_to_open contains URLs of the form
73 rkward://runplugin/...), RKWard will show a warning that such URLs
74 could be used to trigger malicious actions on your system. This
75 warning applies specifically to links found on untrusted websites,
76 or other untrusted external sources. If you want to script RKWard
77 locally, you can avoid this warning by adding --nowarn-external to
78 the command line.
79 files_to_open
81 You can specify any number of file names or URLs for RKWard to
82 open. Usually this will be either workspace files, workplace files,
83 R script files, or rkward:// URLs (e.g. for starting with a plugin
84 dialog). Specifying more than one workspace file will lead to the
85 workspaces being merged together, and is not recommended.
86
88 R(1)
89
91 # Start with the t-test dialog
92 rkward --nowarn-external rkward://runplugin/rkward::t_test/
93 # Open two script files in a running instance of RKWard (or in a fresh instance, if RKWard is not running)
94 rkward --reuse file_a.R file_b.R
95 # Run the rkward backend through valgrind
97 rkward --backend-debugger 'valgrind --log-file=valgrind.log'
98
100 RKWard was written by Thomas Friedrichsmeier and the RKWard team. See
101 the RKWard website[1].
102
104 Thomas Friedrichsmeier <rkward-devel@kde.org>
105 RKWard man page.
106
108 1. the RKWard website
109 https://rkward.kde.org/
110K Desktop Environment 2017-05-20 RKWARD(1)