[education/rkward/devel/workspace_output] rkward/rbackend/rpackages: Roxygenize

[Thomas Friedrichsmeier]

Git commit a19f0663ddf9f5d2a73cada16f6ec337c5a1b5f1 by Thomas Friedrichsmeier.
Committed on 07/03/2022 at 20:51.
Pushed by tfry into branch 'devel/workspace_output'.

Roxygenize

M  +1    -1    rkward/rbackend/rpackages/rkward/DESCRIPTION
M  +1    -0    rkward/rbackend/rpackages/rkward/NAMESPACE
M  +25   -1    rkward/rbackend/rpackages/rkward/man/RK.Output.Rd
M  +1    -1    rkward/rbackend/rpackages/rkwardtests/DESCRIPTION
M  +1    -1    rkward/rbackend/rpackages/rkwardtests/man/rktest.setSuiteStandards.Rd

https://invent.kde.org/education/rkward/commit/a19f0663ddf9f5d2a73cada16f6ec337c5a1b5f1

diff --git a/rkward/rbackend/rpackages/rkward/DESCRIPTION b/rkward/rbackend/rpackages/rkward/DESCRIPTION
index a0ebf00f..f7304768 100755
--- a/rkward/rbackend/rpackages/rkward/DESCRIPTION
+++ b/rkward/rbackend/rpackages/rkward/DESCRIPTION
@@ -19,7 +19,7 @@ Authors at R: c(person(given="Thomas", family="Friedrichsmeier",
         email="rkward-devel at kde.org", role=c("cre","ctb")))
 Version: 0.7.3
 Date: 2020-10-17
-RoxygenNote: 7.1.0
+RoxygenNote: 7.1.2
 Collate: 
     'base_overrides.R'
     'internal.R'
diff --git a/rkward/rbackend/rpackages/rkward/NAMESPACE b/rkward/rbackend/rpackages/rkward/NAMESPACE
index 51c6fab4..ebbb6171 100644
--- a/rkward/rbackend/rpackages/rkward/NAMESPACE
+++ b/rkward/rbackend/rpackages/rkward/NAMESPACE
@@ -77,6 +77,7 @@ export(rk.graph.off)
 export(rk.graph.on)
 export(rk.header)
 export(rk.home)
+export(rk.import.legacy.output)
 export(rk.last.plot)
 export(rk.list)
 export(rk.list.labels)
diff --git a/rkward/rbackend/rpackages/rkward/man/RK.Output.Rd b/rkward/rbackend/rpackages/rkward/man/RK.Output.Rd
index b117894d..ed2a2870 100644
--- a/rkward/rbackend/rpackages/rkward/man/RK.Output.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/RK.Output.Rd
@@ -4,9 +4,16 @@
 \name{RK.Output}
 \alias{RK.Output}
 \alias{rk.output}
+\alias{rk.import.legacy.output}
 \title{Class and functions for organizing RKWard output.}
 \usage{
 rk.output(filename = NULL, create = FALSE, all = FALSE)
+
+rk.import.legacy.output(
+  filename = file.path(rk.home(), "rk_out.html"),
+  import = TRUE,
+  delete = FALSE
+)
 }
 \arguments{
 \item{filename}{The location where an existing output directory is loaded from or saved/exported to. Note that this is usually not the same location where functions such as
@@ -35,13 +42,19 @@ Since version 0.7.5, RKWard supports more than one piece of output. While dealin
              an instance of the \code{RK.Output} reference class, which has methods for subsequent manipulation. Two instances of this class may be pointing to the same
              logical output file/directory (e.g. when loading the same output file, twice), in which case any operation will affect both instances the same.
 
-             Internally, outputs are managed by the RKWard frontend. The frontend will ask to save any unsaved modified output pages on exit.
+             Internally, outputs are managed by the RKWard frontend. The frontend will ask to save any unsaved modified output pages on exit, even if those are not currently shown.
+
+             Output references can be assigned to a symbol, which may be useful when writing to several output files in turn. However, such references should be considered
+             short-lived. Importantly, they will not currently remain valid across sessions. Where this may be a concern, code should obtain a new reference using
+             rk.output(filename="something") at relevant entry points to subsequent code.
 
              At the time of this writing, output is stored in directories containing an HTML index file, and, usually, several image files, and possibly more.
              However other types of output may be supported in the future, and therefore assumptions about the details of the output storage should be avoided.
 
              \code{rk.output} can be used to create or load output files, as well as to obtain a reference to an already loaded output file. After that, use the class methods
              to operate on the reference obtained.
+
+             \code{rk.import.legacy.output} can be used to import an legacy (pre 0.7.3) output file to .rko-format. This function is going to be removed after some time.
 }
 \section{Fields}{
 
@@ -76,3 +89,14 @@ Do not write anything to the target filename, directly! This is purely for infor
 \item{\code{view(raise = TRUE)}}{Open this output for viewing in the frontend.}
 }}
 
+\examples{
+
+## Not run
+x <- rk.output(create=TRUE)
+x$activate()
+rk.print("Hello World!")
+x$view()
+x$save() # Will prompt for filename
+x$close()
+
+}
diff --git a/rkward/rbackend/rpackages/rkwardtests/DESCRIPTION b/rkward/rbackend/rpackages/rkwardtests/DESCRIPTION
index cccd1721..9d3bc1f1 100644
--- a/rkward/rbackend/rpackages/rkwardtests/DESCRIPTION
+++ b/rkward/rbackend/rpackages/rkwardtests/DESCRIPTION
@@ -31,4 +31,4 @@ Collate:
     'rkwardtests-internal.R'
     'rkwardtests-package.R'
     'show-method.R'
-RoxygenNote: 7.1.1
+RoxygenNote: 7.1.2
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/rktest.setSuiteStandards.Rd b/rkward/rbackend/rpackages/rkwardtests/man/rktest.setSuiteStandards.Rd
index 66c85e42..ad2e04e5 100644
--- a/rkward/rbackend/rpackages/rkwardtests/man/rktest.setSuiteStandards.Rd
+++ b/rkward/rbackend/rpackages/rkwardtests/man/rktest.setSuiteStandards.Rd
@@ -19,7 +19,7 @@ The function simply copies the previously created files from the temporary direc
        to the directory containing the test standards (inside the testroot).
 }
 \description{
-Use this function after you plugin passed all tests to set the resulting code,
+Use this function after your plugin passed all tests to set the resulting code,
 output and R messages as the standard that will be compared to during following tests.
 }
 \details{