document hash

mllg · Dec 11, 2017 · 81f120f · 81f120f
1 parent 172880c
commit 81f120f
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -2,6 +2,8 @@
 
 * Renamed column "memory" in the status table to "mem.used" to avoid name clashes with the resource specification.
 * Exported function `assertRegistry()`.
+* Registries now contain a unique hash which is updated each time the registry is altered.
+  Can be utilized to invalidate caches, e.g. the cache of knitr.
 
 # batchtools 0.9.7
 

diff --git a/R/Registry.R b/R/Registry.R
@@ -102,6 +102,7 @@
 #'     \item{\code{status} [data.table]:}{Table holding information about the computational status. Also see \code{\link{getJobStatus}}.}
 #'     \item{\code{resources} [data.table]:}{Table holding information about the computational resources used for the job. Also see \code{\link{getJobResources}}.}
 #'     \item{\code{tags} [data.table]:}{Table holding information about tags. See \link{Tags}.}
+#'     \item{\code{hash} [character(1)]:}{Unique hash which changes each time the registry gets saved to the file system. Can be utilized to invalidate the cache of \pkg{knitr}.}
 #'   }
 #' @aliases Registry
 #' @family Registry

diff --git a/man/makeRegistry.Rd b/man/makeRegistry.Rd