Support for search with regular expressions.

Author: jsugarelli

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: packagefinder
 Type: Package
 Title: Comfortable Search for R Packages on CRAN, Either Directly from the R Console or with an R Studio Add-in
-Version: 0.3.1
+Version: 0.3.2
 Authors@R: person("Joachim", "Zuckarelli", role = c("aut", "cre"), email = "[email protected]", comment = c(ORCID = "0000-0002-9280-3016"))
 Maintainer: Joachim Zuckarelli <[email protected]>
 Description: Search for R packages on CRAN directly from the R console, based on the packages' titles, short and long descriptions, or other fields. Combine multiple keywords with logical operators ('and', 'or'), view detailed information on any package and keep track of the latest package contributions to CRAN. If you don't want to search from the R console, use the comfortable R Studio add-in.

NEWS.md

@@ -1,8 +1,17 @@
+# packagefinder 0.3.2
+
+## Minor changes
+
+* `findPackage()` and the RStudio add-in now support search with regular expressions (new argument `query` in `findPackage()`)
+* Button to save options in the RStudio add-in added to ensure correct storing of add-in default values.
+
+
+
 # packagefinder 0.3.1
 
 ## Bug fix
 
-Bug fixed that prevented intallation of the package on certain Linux distributions.
+* Bug fixed that prevented installation of the package on certain Linux distributions.
 
 
 

R/addin.r

@@ -37,7 +37,7 @@ getPackageDetailsHTML <- function(df) {
     "Reverse imports",
     "Reverse suggests"
   )
-
+  
   headers <- c(
     "Name",
     "Short description",
@@ -57,7 +57,7 @@ getPackageDetailsHTML <- function(df) {
     "Reverse imports",
     "Reverse suggests"
   )
-
+  
   placeholders <- c(
     NA,
     NA,
@@ -118,7 +118,7 @@ getPackageDetailsHTML <- function(df) {
     NA,
     NA
   )
-
+  
   html <- "<div style=\"background-color: #FCFAFA; padding-left: 20px\">"
   for(i in 1:NROW(fields)) {
     if(!is.na(df[1, fields[i]])) {
@@ -186,7 +186,8 @@ processSearch <- function(search = TRUE, input, package.list) {
         }
         mode <- tolower(input$rad_mode)
         terms <- scan(text = input$txt_search, what = "character")
-        res <- findPackage(terms, silent = TRUE, return.df = TRUE, mode = mode, case.sensitive = case.sensitive, always.sensitive = always.sensitive, index = getOption("packagefinder.index", NULL))
+        if(!input$chk_regex) res <- findPackage(terms, silent = TRUE, return.df = TRUE, mode = mode, case.sensitive = case.sensitive, always.sensitive = always.sensitive, index = getOption("packagefinder.index", NULL))
+        else res <- findPackage(query=terms, silent = TRUE, return.df = TRUE, mode = mode, case.sensitive = case.sensitive, always.sensitive = always.sensitive, index = getOption("packagefinder.index", NULL))
       }
     }
   }
@@ -202,7 +203,7 @@ processSearch <- function(search = TRUE, input, package.list) {
   }
   if(!is.null(res)) {
     num.results <- NROW(res)
-
+    
     res[,"Long Description"] <- NULL
     orig.name <- res$Name
     res$GO <- NULL
@@ -226,7 +227,7 @@ processSearch <- function(search = TRUE, input, package.list) {
         }
       }
     }
-
+    
     for(i in 1:NROW(res)) {
       if(orig.name[i] %in% inst[,"Package"]) {
         res$Installed[i] = "Installed"
@@ -235,19 +236,19 @@ processSearch <- function(search = TRUE, input, package.list) {
         res$Installed[i] <- paste0("<img src=\"https://www.zuckarelli.de/files/download-col.png\" style=\"height:32px\"
                 title = \"Install package '", orig.name[i] , "' (with dependencies)\"/>")
       }
-
+      
       res$ActionPDF[i] <- buildLink(
         link.url = paste0("https://cran.r-project.org/web/packages/", res$Name[i], "\\", res$Name[i], ".PDF"),
         image.url = "https://www.zuckarelli.de/files/PDF-col.png",
         tooltip = paste0("PDF manual of package '", res$Name[i], "'")
       )
-
+      
       res$ActionWeb[i] <- buildLink(
         link.url = paste0("https://cran.r-project.org/web/", res$Name[i]),
         image.url = "https://www.zuckarelli.de/files/r-col.png",
         tooltip = paste0("CRAN website of package '", res$Name[i], "'")
       )
-
+      
       github.url <- df_ext$GitHub[which(df_ext$Package == res$Name[i])]
       if(!is.na(github.url)) {
         res$ActionGitHub[i] <- buildLink(
@@ -260,13 +261,13 @@ processSearch <- function(search = TRUE, input, package.list) {
         res$ActionGitHub[i] <- ""
       }
     }
-
+    
     res$Name = paste0("<span style=\"font-weight:bold\">", res$Name, "</span>")
   }
   else {
     num.results <- 0
   }
-
+  
   return(list(df = res, df_ext = df_ext, num.results = num.results))
 }
 
@@ -288,6 +289,7 @@ getPackageFinderCode <- function(input, search = TRUE, cran.days = 3) {
     terms <- scan(text = input$txt_search, what = "character")
     if(NROW(terms) > 1) terms <- paste0("c(", paste0(paste0("\"", terms, "\""), collapse = ", "), ")")
     else terms <- paste0("\"", terms, "\"")
+    if(input$chk_regex) terms <- paste0("query = ", terms)
     code <- paste0("findPackage(", terms, mode, case.sensitive, always.sensitive, ")")
   }
   else {
@@ -314,4 +316,4 @@ waitUI <- function(code) {
                               </table><p id='p1'>&nbsp;</p><p id='p2'>&nbsp;</p>"))
     ),
     ))
-}
+}

R/addintools.r

@@ -26,10 +26,12 @@ html.viewHTML <- function() {
 
 
 html.header <- function() {
- func.call <- deparse(getOption("packagefinder.call", ""))
- call.info <- paste0("<form>Original call: <input type=\"text\" readonly size=", round(nchar(func.call)*1.5,0)," style=\"border:0px;font-family:'Cutive Mono';font-size:17px\"  value='", func.call,"' id=\"code\"><br><input type=\"button\" value=\"Copy to clipboard\" class=\"button\" onclick=\"var copyText=document.getElementById('code');copyText.select(); document.execCommand('copy')\"></form>")
- keywords.info <- paste(paste0("<span style=\"font-weight:bold;\">", getOption("packagefinder.keywords", ""), "</span>"), collapse=paste0(" <span style=\"color:#cfcfcf;\">", getOption("packagefinder.mode", ""), "</span> "))
- html.code <- paste0("
+  func.call <- deparse(getOption("packagefinder.call", ""))
+  call.info <- paste0("<form>Original call: <input type=\"text\" readonly size=", round(nchar(func.call)*1.5,0)," style=\"border:0px;font-family:'Cutive Mono';font-size:17px\"  value='", func.call,"' id=\"code\"><br><input type=\"button\" value=\"Copy to clipboard\" class=\"button\" onclick=\"var copyText=document.getElementById('code');copyText.select(); document.execCommand('copy')\"></form>")
+  keywords.info <- paste(paste0("<span style=\"font-weight:bold;\">", getOption("packagefinder.keywords", ""), "</span>"), collapse=paste0(" <span style=\"color:#cfcfcf;\">", getOption("packagefinder.mode", ""), "</span> "))
+  if(getOption("packagefinder.searchtype", "") == "query") searchtype <- " (regular expression)"
+  else searchtype <- " (keywords)"
+  html.code <- paste0("
     <table>
       <tr>
         <td style=\"width:20%\">
@@ -38,7 +40,7 @@ html.header <- function() {
         <td style=\"padding-left:20px; width:80%\">
           <p style=\"font-size:36px;\">Search Results</p>
           <p>", call.info, "</p>
-          <p>Search query: ", keywords.info, "</p>
+          <p>Search", searchtype, ": ", keywords.info, "</p>
           <p><span style=\"font-weight:bold\">", getOption("packagefinder.num.results", "") ,"</span> of <span style=\"font-weight:bold\">", getOption("packagefinder.num.cran", ""), "</span> CRAN packages found in <span style=\"font-weight:bold\">", getOption("packagefinder.timediff", ""), "</span> seconds.</p>
         </td>
       </tr>
@@ -58,7 +60,7 @@ html.colorscore <- function(scores) {
   red <- format(as.hexmode(255-round(255 * scores/100,0)), width=2)
   green <- format(as.hexmode(255), width=2)
   blue <- format(as.hexmode(255-round(255 * scores/100,0)), width=2)
-
+  
   return(paste0("#", red, green, blue))
 }
 
@@ -76,9 +78,9 @@ html.formatdf <- function(df) {
   keywords <- getOption("packagefinder.keywords", NULL)
   df[,"Long Description"] <- textutils::HTMLencode(df[,"Long Description"])
   df[,NCOL(df)] <- NULL    # Cut-off GO number
-#  df[, "Score"] <- paste0(format(df[, "Score"], nsmall=1), "<span style=\"padding-left:10px; color:", html.colorscore(df[, "Score"]),"\">", html.getbar(df[, "Score"]), "</span>")
+  #  df[, "Score"] <- paste0(format(df[, "Score"], nsmall=1), "<span style=\"padding-left:10px; color:", html.colorscore(df[, "Score"]),"\">", html.getbar(df[, "Score"]), "</span>")
   df[, "Score"] <- paste0(format(df[, "Score"], nsmall=1), "<span style=\"padding-left:10px; color:#1ddb1d\">", html.getbar(df[, "Score"]), "</span>")
-
+  
   if("Total Downloads" %in% colnames(df)) df[,"Total Downloads"] <- NULL
   df[,"Total Downloads"] <- paste0("<img src=\"https://cranlogs.r-pkg.org/badges/grand-total/", df$Name,"\"/>")
   linkspart.manual <- paste0("<a target=\"_blank\" href=\"https://cran.r-project.org/web/packages/", df$Name, "/", df$Name, ".pdf\"><img style=\"align-vertical:middle; padding-right:5px; width:28px\" src=\"http://www.zuckarelli.de/files/pdf-col.png\" /></a>")
@@ -87,13 +89,13 @@ html.formatdf <- function(df) {
   df$Links <- paste0("<div>", linkspart.manual, linkspart.cranpage, linkspart.google, "</div>")
   df[,"Install code"] <- paste0("<form> <input type=\"button\" class=\"button\" value=\"Copy\" onclick=\"var copyText=document.getElementById('install_",df$Name,"');copyText.select(); document.execCommand('copy')\"><input type \"text\" style=\"position: relative; left: -10000px;\" id=\"install_", df$Name,"\" value=\'install.packages(\"",df$Name,"\", dependencies = TRUE)'></form>")
   df$Name <- paste0("<a href=\"https://cran.r-project.org/package=", df$Name, "\">", df$Name, "</a>")
-
+  
   for(i in 1:NROW(keywords)) {
     df$Name <- gsub(paste0("(.*^=",keywords[i],")"), "<span style=\"background-color:#e6f1ff\">\\1</span>", df$Name, ignore.case = TRUE, perl=TRUE)
     df[,"Short Description"] <- gsub(paste0("(",keywords[i],")"), "<span style=\"background-color:#e6f1ff\">\\1</span>", df[,"Short Description"], ignore.case = TRUE, perl=TRUE)
     df[,"Long Description"] <- gsub(paste0("(",keywords[i],")"), "<span style=\"background-color:#e6f1ff\">\\1</span>", df[,"Long Description"], ignore.case = TRUE, perl=TRUE)
   }
-
+  
   css.cols <- rep("", NCOL(df))
   css.cols[1] <- "border-bottom:1pt solid #d1d1d1; padding: 7px; vertical-align:top"
   css.cols[2] <- "border-bottom:1pt solid #d1d1d1; padding: 7px; width:8%; vertical-align:top"
@@ -102,7 +104,7 @@ html.formatdf <- function(df) {
   css.cols[5] <- "border-bottom:1pt solid #d1d1d1; padding: 7px; vertical-align:top; text-align:center"
   css.cols[6] <- "border-bottom:1pt solid #d1d1d1; padding: 7px; width:10%; vertical-align:top; text-align:center"
   css.cols[7] <- "border-bottom:1pt solid #d1d1d1; padding: 7px; vertical-align:top; text-align:center"
-
+  
   html.code <- htmlTable::htmlTable(
     df,
     align = paste0(c(rep("l", NCOL(df)-2),"c", "c")),
@@ -130,8 +132,8 @@ html.buildDoc <-function(body.html) {
         </style>
       </head>
       <body style=\"font-family:'Hind Madurai'; color:#494949; backgroundcolor:#FFFFFF;\">",
-        body.html,
-      "</body>
+                      body.html,
+                      "</body>
     <html>")
   return(html.code)
-}
+}