R/shinySearchInLocalRepo.R

In pbiecek/archivist: Tools for Storing, Restoring and Searching for R Objects

##    archivist package for R
##
#' @title Shiny Based Live Search for an Artifact in a Repository Using Tags 
#'
#' @description
#' \code{shinySearchInLocalRepo} searches for an artifact in a \link{Repository} using \link{Tags}.
#' To create an application one needs to point the name of artifacts' repository.
#' The application is generated on the run. As for now there are two controllers exposed. 
#' A text input field and a slider. Tags that are typed into text field are used for searching in repository. 
#' Objects that have the same Tags are presented on the right panel.
#' These object might be also downloaded just by click.
#' To learn more about artifacts visit \link[archivist]{archivist-package}.
#' 
#' @details
#' \code{shinySearchInLocalRepo} searches for artifacts in a Repository using their \code{Tags} 
#' (e.g., \code{name}, \code{class} or \code{archiving date}). \code{Tags} are submitted in a 
#' text input in a shiny application. Many Tags may be specified, they should be comma separated. 
#' User can specify more Tags like phase, project, author etc. when artifact is created.
#' 
#' In the search query one can add Tags starting with \code{sort:} or \code{sort:-}.
#' As a result, miniatures will be sorted appropriately.
#' For example \code{sort:class} will sort \code{class} Tags, while \code{sort:-class} will
#' sort \code{class} tags backwards. \code{sort:createdDate} will sort \code{createdDate} Tag and
#' \code{sort:-createdDate} will sort \code{createdDate} Tag backwards.
#' 
#' \code{Tags}, submitted in the text field, should be given according to the 
#' format: \code{"TagKey:TagValue"} - see examples.
#'   
#' @return
#' \code{shinySearchInLocalRepo} runs a shiny application.
#' 
#' @param repoDir A character denoting an existing directory in which artifacts will be searched.
#' If set to \code{NULL} (by default), uses the \code{repoDir} specified in \link{setLocalRepo}.
#' 
#' @param host A host IP adress, see the \code{host} argument in \code{shiny::runApp}.
#' 
#' @author
#' Przemyslaw Biecek, \email{przemyslaw.biecek@@gmail.com}
#'
#' @template roxlate-references
#' @template roxlate-contact
#'
#' @section shiny:
#'
#' This function use tools from the fantastic \pkg{shiny}
#' package, so you'll need to make sure to have it installed.
#'
#' @examples
#' \dontrun{
#'   # assuming that there is a 'repo' dir with a valid archivist repository
#'   shinySearchInLocalRepo( repoDir = 'repo' )
#' }
#' @family archivist
#' @rdname shinySearchInRepo
#' @export
shinySearchInLocalRepo <- function( repoDir=NULL, host = '0.0.0.0' ){
  if (!requireNamespace("shiny", quietly = TRUE)) {
    stop("shiny package required for shinySearchInLocalRepo function")
  }
  stopifnot( ( is.character( repoDir ) & length( repoDir ) == 1 ) | is.null( repoDir ) )

  shiny::runApp(list(
    ui = shiny::shinyUI(shiny::fluidPage(
      shiny::tags$head(
        shiny::tags$style(shiny::HTML("div.span4 {
                        width: 300px!important;
}"))),
    
      shiny::titlePanel(paste0("Live search in the ",repoDir)),
      shiny::sidebarLayout(
        shiny::sidebarPanel(
          shiny::textInput("search","Comma separated tags",value = "class:ggplot"),
          shiny::sliderInput("width", "Image width", min=100, max=800, value=400)),
        shiny::mainPanel(
          shiny::uiOutput("plot")
        )
      )
        )),
    server = function(input, output) {
      output$plot <- shiny::renderUI({ 
        tags <- strsplit(input$search, split=" *, *")[[1]]
        sortTags <- grep(tags, pattern="^sort:")
        # Tags with sort: key should be removed from search
        if (length(sortTags) > 0) {
          md5s <- multiSearchInLocalRepoInternal( tags[-sortTags], repoDir, fixed = FALSE, intersect = TRUE )
        } else {
          md5s <- multiSearchInLocalRepoInternal( tags, repoDir, fixed = FALSE, intersect = TRUE )
        }
        # should we sort results
        if (length(sortTags) > 0 & length(md5s) > 0) {
          allTags <- showLocalRepo(repoDir, method = "tags")
          selectedTags <- allTags[allTags$artifact %in% md5s,]
          if (tags[sortTags[1]] == "sort:createdDate") {
            md5s <- unique(selectedTags$artifact[order(selectedTags$createdDate)])
          } else {
            if (tags[sortTags[1]] == "sort:-createdDate") {
              md5s <- unique(selectedTags$artifact[order(selectedTags$createdDate, decreasing = TRUE)])
            } else {
              # if there is - before sort condition
              key <- substr(tags[sortTags[1]], 6, 1000)
              if (substr(key, 1, 1) == "-") {
                tmpTags <- selectedTags[grep(selectedTags$tag,pattern = substr(key, 2, 1000)),,drop=FALSE]
                md5s <- unique(tmpTags[order(tmpTags$tag, na.last = TRUE),"artifact"])
              } else {
                tmpTags <- selectedTags[grep(selectedTags$tag,pattern = key),,drop=FALSE]
                md5s <- unique(tmpTags[order(tmpTags$tag),"artifact"])
              }
            }
          }
        }
        
        shiny::addResourcePath(
          prefix="repo", 
          # if it's absolute path, do not add anything
          directoryPath=ifelse(substr(repoDir,1,1) == "/",
                               repoDir,
                               paste0(getwd(),"/",repoDir))
          )
        
        res <- ""
        if (length(md5s) > 0) {
          res <-  paste(
            paste0("<a href='repo/gallery/", md5s, ".rda'><img width=",input$width," src='repo/gallery/", md5s, ".png'/></a>"), 
            collapse="")
        } 
        
        shiny::HTML(res)
      })
    }
  ), host = host)
  
}