fix import and docs closes #86 opens #96

.github/workflows/main.yaml

@@ -30,7 +30,7 @@ jobs:
       - name: Check
         run: |
           shinytest::installDependencies()
-          devtools::check(document = FALSE, error_on = "error")
+          devtools::check(document = FALSE)
       - name: Test Coverage
         run: covr::codecov()
       - name: Build Package Website

DESCRIPTION

@@ -59,7 +59,8 @@ Suggests:
     memoise (>= 2.0.0),
     cachem (>= 1.0.4),
     httptest (>= 4.0.0),
-    shinyjs (>= 2.0.0)
+    shinyjs (>= 2.0.0),
+    htmlwidgets (>= 1.5.3)
 Remotes:
   subugoe/[email protected],
   subugoe/[email protected]

NAMESPACE

@@ -35,7 +35,10 @@ export(is_doi_from_ra)
 export(is_doi_ish)
 export(is_doi_resolvable)
 export(regex_doi)
+export(renderView_doi_matches)
 export(resolve_doi)
 export(str_extract_all_doi)
 export(str_extract_doi)
+export(view_doi_matches)
+export(view_doi_matchesOutput)
 import(vctrs)

R/doi.R

@@ -598,9 +598,17 @@ one_doi <- function(value) {
 
 #' View HTML rendering of matched DOIs
 #' htmlwidget to show how DOIs are matched in strings.
+#'
+#' @details
+#' Highlighting DOIs matching the regular expression
+#' can help users troubleshoot their input,
+#' for example inside shiny apps.
+#'
 #' @inheritParams stringr::str_view_all
+#' @examples
+#' view_doi_matches("lorem ipsum 10.1000/foo dolor ist 10.1000/bar")
 #' @family doi
-#' @noRd
+#' @export
 view_doi_matches <- function(string) {
   stringr::str_view_all(
     string = string,
@@ -611,7 +619,7 @@ view_doi_matches <- function(string) {
 #' @describeIn view_doi_matches
 #' Shiny output widget to show matched DOIs
 #' @inheritParams htmlwidgets::shinyWidgetOutput
-#' @noRd
+#' @export
 view_doi_matchesOutput <- function(outputId, width = "100%", height = "auto") {
   require_namespace2("htmlwidgets")
   htmlwidgets::shinyWidgetOutput(
@@ -626,7 +634,7 @@ view_doi_matchesOutput <- function(outputId, width = "100%", height = "auto") {
 #' @describeIn view_doi_matches
 #' Shiny render function to show matched DOIs
 #' @inheritParams htmlwidgets::shinyRenderWidget
-#' @noRd
+#' @export
 renderView_doi_matches <- function(expr, env = parent.frame(), quoted = FALSE) {
   require_namespace2("htmlwidgets")
   if (!quoted) {

README.md

@@ -10,6 +10,7 @@
 
 In bibliometric analysis, we frequently work with specialised identifiers, such as [Digital Object Identifiers (DOIs)](https://www.doi.org) or [Research Organisation Registry IDs (RORs)](https://ror.org).
 The goal of biblids is to help you work with these identifiers.
+
 ## Vctrs S3 Classes
 
 Biblids implements bibliometric identifiers as S3 classes based on the [vctrs](https://vctrs.r-lib.org) package.