fixes for #298

NAMESPACE

@@ -13,8 +13,10 @@ export(ahistory)
 export(alink)
 export(aoptions)
 export(aread)
+export(areadLocal)
 export(asave)
 export(asearch)
+export(asearchLocal)
 export(asession)
 export(atrace)
 export(cache)

NEWS.md

@@ -1,5 +1,6 @@
 archivist 2.2
 ----------------------------------------------------------------
+* Two new functions `asearchLocal()` and `areadLocal()` that work as `asearch()` and `aread()` for selected local repositories ([#298](https://github.com/pbiecek/archivist/issues/298)).
 * parameter `force` has now different meaning in `createLocalRepo()`. As suggested in ([#319](https://github.com/pbiecek/archivist/issues/319)) and ([#318](https://github.com/pbiecek/archivist/issues/318)) if forces to override existing backpack.db file.
 * Updated CITATION
 

R/aread.R

@@ -74,3 +74,38 @@ aread <- function(md5hash){
   }
   if (length(res) == 1) return(res[[1]]) else res
 }
+
+#' @title Read Artifacts Given as md5hashes from the Repository
+#'
+#' @description
+#' \code{areadLocal} reads the artifact from the Local \link{Repository}. It's a wrapper around 
+#' \link{loadFromLocalRepo}.
+#' 
+#' @details
+#' Function \code{areadLocal} reads artifacts (by \code{md5hashes}) from Local Repository.
+#' 
+#' @param md5hash A character vector which elements  are consisting name of the repository and name of the artifact (MD5 hash) or it's abbreviation.
+#' 
+#' @param repo A character with path to local repository.
+#' 
+#' @author 
+#' Przemyslaw Biecek, \email{przemyslaw.biecek@@gmail.com}
+#' 
+#' @template roxlate-references
+#' @template roxlate-contact
+#' 
+#' @family archivist
+#' @rdname areadLocal
+#' @export
+areadLocal <- function(md5hash, repo){
+  stopifnot( (is.character( repo ) & length( repo ) == 1) | is.null( repo ) )
+  stopifnot( is.character( md5hash ) )
+
+  # work for vectors  
+  res <- list()
+  for (md5h in md5hash) {
+    # at least 3 elements
+      res[[md5h]] <- loadFromLocalRepo(md5hash = md5h, value = TRUE, repoDir = repo)
+  }
+  if (length(res) == 1) return(res[[1]]) else res
+}

R/asearch.R

@@ -149,3 +149,45 @@ asearch <- function( patterns, repo = NULL){
   } 
   res
 }
+
+#' @title Read Artifacts Given as a List of Tags
+#'
+#' @description
+#' \code{asearchLocal} searches for artifacts that contain all specified \link{Tags}
+#' and reads all of them from a local \link{Repository}. It's a wrapper around 
+#' \link{searchInLocalRepo} and \link{loadFromLocalRepo}.
+#' 
+#' @details
+#' Function \code{asearchLocal} reads all artifacts that contain given list of \code{Tags}
+#' from the selected Local Repository.
+#' 
+#' @param repo A character with path to local repository.
+#' 
+#' @param patterns  A character vector of \code{Tags}. Only artifacts that 
+#' contain all Tags are returned.  
+#' 
+#' @return This function returns a list of artifacts (by their values).
+#' 
+#' @author 
+#' Przemyslaw Biecek, \email{przemyslaw.biecek@@gmail.com}
+#' 
+#' @template roxlate-references
+#' @template roxlate-contact
+#' @family archivist
+#' @rdname asearchLocal
+#' @export
+asearchLocal <- function( patterns, repo = NULL){
+  stopifnot( (is.character( repo ) & length( repo ) == 1) | is.null( repo ) )
+  stopifnot( is.character( patterns ) )
+
+  oblist <- multiSearchInLocalRepoInternal(patterns = patterns,
+                                           repoDir = repo,
+                                           intersect = TRUE)
+  if (length(oblist) > 0) {
+    res <- lapply(oblist, loadFromLocalRepo, value = TRUE)
+    names(res) <- oblist
+  } else {
+    res <- list()
+  }
+  res
+}