docs: small improvements

NEWS.md

@@ -3,6 +3,7 @@
 * Column names can often now be additionally specified by a character string containing either comma separated column names, for example, `"x,y,z"`, or the start and end column separated by a colon, for example, `"x:z"`
 * Fixed a bug in `interpolateLinear()` causing partial last observation carried forward behaviour when its `roll` argument was specified smaller than the size of the gap to be interpolated
 * Fixed a bug in `interpolateLinear()` causing partial interpolation in certain cases when its `roll` argument was specified smaller than the size of the gap to be interpolated
+* Slightly improved documentation
 
 # DTSg v1.0.0
 

R/Swrappers.R

@@ -16,7 +16,7 @@
 #' @seealso [`S3Methods`], [`R6::R6Class`]
 #'
 #' @examples
-#' # generate an S3 wrapper method for 'alter' of 'DTSg'
+#' # generate an S3 wrapper method for 'alter()' of 'DTSg'
 #' alter.DTSg <- S3WrapperGenerator(
 #'   R6Method = DTSg$public_methods$alter
 #' )
@@ -431,6 +431,9 @@ cols <- function(x, ...) {
 #' ## R6 method
 #' x$cols(class = "numeric")
 #'
+#' ## 'names()' is a "hidden" R6 alias for 'cols()'
+#' x$names(class = "numeric")
+#'
 #' ## S3 method
 #' cols(x = x, class = "numeric")
 #'
@@ -826,6 +829,12 @@ rowaggregate <- function(x, ...) {
 #'   fun = list(mean = mean, sd = sd)
 #' )$print()
 #'
+#' ## 'raggregate()' is a "hidden" R6 alias for 'rowaggregate()'
+#' x$raggregate(
+#'   resultCols = "flow",
+#'   fun = list(mean = mean, sd = sd)
+#' )$print()
+#'
 #' ## S3 method
 #' print(rowaggregate(
 #'   x = x,
@@ -867,6 +876,12 @@ rowbind <- function(x, ...) {
 #'   flow[1501:.N, ]
 #' )$print()
 #'
+#' ## 'rbind()' is a "hidden" R6 alias for 'rowbind()'
+#' x$rbind(
+#'   list(flow[1001:1500, ], DTSg$new(values = flow[501:1000, ])),
+#'   flow[1501:.N, ]
+#' )$print()
+#'
 #' ## S3 method
 #' print(rowbind(
 #'   x = x,
@@ -913,6 +928,12 @@ setColNames <- function(x, ...) {
 #'   values = "River Flow"
 #' )$print()
 #'
+#' ## 'setnames()' is a "hidden" R6 alias for 'setColNames()'
+#' x$setnames(
+#'   cols = "flow",
+#'   values = "River Flow"
+#' )$print()
+#'
 #' ## S3 method
 #' print(setColNames(
 #'   x = x,
@@ -965,6 +986,13 @@ setCols <- function(x, ...) {
 #'   values = 100
 #' )$print()
 #'
+#' ## 'set()' is a "hidden" R6 alias for 'setCols()'
+#' x$set(
+#'   i = flow > 100,
+#'   cols = "flow",
+#'   values = 100
+#' )$print()
+#'
 #' ## S3 method
 #' print(setCols(
 #'   x = x,