RKWARD(1)

💖 RKWARD 💖

ok so bestie. this is the manual page for rkward — like, the actual RKWard User's Manual — and I'm gonna walk you through every single flag because you deserve to know. no gatekeeping in this house. 🫶

---

✨ NAME ✨

rkward — it's giving KDE frontend to R. literally what it says on the tin: a KDE-based frontend to the R language. 👑

---

🎀 SYNOPSIS 🎀

rkward [--evaluate Rcode] [--debug-level level] [--debug-flags flags]
       [--debug-output where] [--backend-debugger debugger_command]
       [--r-executable path_to_executable] [--reuse] [--autoreuse]
       [--nowarn-external] [KDE Generic Options] [Qt Generic Options]
       [files_to_open]

---

🌸 DESCRIPTION 🌸

RKWard is the KDE-based GUI and IDE for the R scripting language for statistical computing. it's the whole package, bestie. GUI and IDE. slay.

if you want more info, go look at the RKWard website¹, and also the docs that are literally shipped inside RKWard itself. iykyk. ✨

---

💅 OPTIONS 💅

okay this is the part you actually came for. every flag, no skips, periodt.

• --evaluate Rcode — your given R code gets evaluated after RKWard has started, and after any specified workspace is loaded. mostly useful for automated testing. that's its whole job. 🧚
• --debug-level level — how chatty the debug output is. ranges 0-5, where 0 is no output at all and 5 is everything, including function trace information. default is 2. 🌈
• --debug-output where — where the debug output goes. default is to store it in a file in the temporary directory. if you specify "terminal" it'll write debug output to stderr instead (super useful for debugging startup problems, fr fr). > heads up though: debug output from the backend process is always stored in a file. no exceptions. 😭
• --debug-flags flags — picks which sections of code to debug. the flags are given as a binary number. refer to the source files for documentation because this one really is an internal option, bestie. 💀
• --backend-debugger command — runs the RKWard backend through the debugger command you specify. want to add command line options to that debugger command? enclose them in single quotes ('') together with the command. > NOTE: debugger arguments will be split by spaces. if that's not appropriate for you, you'll 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 below. 🎀
• --r-executable command — when you've got several R installations chilling on your machine, use this to specify which one to use, e.g. /usr/bin/R. you can also pass the string "auto", and then RKWard will try to find R at one of the known standard installation paths. > NOTE that while RKWard will often work with newer versions of R, it will sometimes need to be re-compiled for that version, or it may be incompatible altogether. 💀

this option changes the R installation only for the current session, not persistently. so it's a one-session kinda deal. 💜

• --reuse — if an instance of RKWard is already running, bring that one to the front and open files_to_open in it. > note that all other command line options will be ignored in case an instance is reused. like, all of them. 🫶
• --autoreuse — behaves like --reuse if any file arguments are also given; otherwise it starts a new instance. intended for use in the .desktop file. ✨
• --nowarn-external — usually, when you invoke RKWard plugins from the command line (i.e. when files_to_open contains URLs of the form rkward://runplugin/...), RKWard will show a warning that such URLs could be used to trigger malicious actions on your system. that warning applies specifically to links found on untrusted websites, or other untrusted external sources. if you want to script RKWard locally, you can dodge this warning by adding --nowarn-external to the command line. 🔥

(if used in combination with --reuse, then both commands in question will need to be invoked with --nowarn-external in order to suppress the warning. both. yes really.) 🙈

• --setup — acts as if a new version of RKWard had been installed: importantly re-installing the R support package, and showing the setup wizard. mostly targetted at developers and testers. 🧚
• --quirkmode — disables some startup validation code. > experimental option, not intended for regular use. you've been warned bestie. ⭐
• files_to_open — you can specify any number of file names or URLs for RKWard to open. usually this'll 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. 💅

---

🦋 SEE ALSO 🦋

R(1)

---

🌈 EXAMPLES 🌈

    # 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 'valgrind --log-file=valgrind.log'

---

👑 AUTHORS 👑

RKWard was written by Thomas Friedrichsmeier and the RKWard team. see the RKWard website¹. 🫶

---

💜 AUTHOR 💜

Thomas Friedrichsmeier <rkward@kde.org>

• RKWard man page. (yes that's literally what it says. iconic of them tbh.)

---

🍓 NOTES 🍓

1. the RKWard website https://rkward.kde.org/

---

okay that's the whole thing, you're basically a RKWard scholar now. go forth and --evaluate something. 💖

KDE Applications RKWard 0.8.0 · 2024-05-26 — that's the source/version and date this page came from, so if you're reading it in like 2077 just know it's an older queen. mwah, bye bestie! 💅✨🎀🦋🌸