doc

Author: Stefan Fleck

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: rotor
 Title: Log Rotation and Conditional Backups
-Version: 0.2.4.9003
+Version: 0.2.4.9004
 Authors@R: 
     person(given = "Stefan",
            family = "Fleck",

NEWS.md

@@ -1,10 +1,11 @@
-# rotor (dev version)
+# rotor 0.2.5
 
 * Improved some error messages
 * Added `rotate_rds()`, `rotate_rds_time()`, and `rotate_rds_date()` as a
   replacement for `base::saveRDS()` that supports creating backups instead of
   just overwriting the destination file.
-* added `Cache`, an R6 class for managing cache directories
+* added `Cache`, an R6 class for managing cache directories. The `Cache` API
+  is still experimental and might change.
 * **breaking** R6 API: renamed some methods and active fields of BackupQueue to
   more universal names:
    - `$push_backup()` -> `$push()`

R/BackupQueue.R

@@ -116,6 +116,8 @@ BackupQueue <- R6::R6Class(
 
 
     # ... setters -------------------------------------------------------------
+    #' Set the file to be backed up
+    #' @param x a `character` scalar. Path to a file
     set_origin = function(
       x
     ){
@@ -129,6 +131,8 @@ BackupQueue <- R6::R6Class(
     },
 
 
+    #' Set the file to be backed up
+    #' @param x a `character` scalar. Path to a file
     set_compression = function(
       x
     ){
@@ -401,6 +405,10 @@ BackupQueueIndex <- R6::R6Class(
     },
 
 
+    #' @description Increment die Indices of all backups by `n` Usually does
+    #' not have to be called manually.
+    #'
+    #' @param n `integer` > 0
     increment_index = function(
       n = 1
     ){
@@ -433,6 +441,7 @@ BackupQueueIndex <- R6::R6Class(
 
   # ... getters -------------------------------------------------------------
   active = list(
+
     files = function(){
       res <- super$files
       if (nrow(res) < 1)

R/Cache.R

@@ -1,4 +1,4 @@
-# CacheQueue --------------------------------------------------------------
+# Cache ----------------------------------------------------------------
 
 #' An R6 class for managing a persistent file-based cache
 #'
@@ -112,7 +112,7 @@ Cache <- R6::R6Class(
       invisible(NULL)
     },
 
-    #' @description Read anr remove a single file from the cache
+    #' @description Read and remove a single file from the cache
     #' @param key `character` scalar. key of the cached file to read/remove
     pop = function(
       key