update documentation

DESCRIPTION

@@ -5,14 +5,17 @@ Authors@R:
     person("First", "Last", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "YOUR-ORCID-ID"))
 Description: What the package does (one paragraph).
-License: `use_mit_license()`, `use_gpl3_license()` or friends to pick a
-    license
+License: GPL (>= 3) | file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.2.3
 Imports: 
     mvbutils,
-    tools
+    tools,
+    hexSticker,
+    jsonlite,
+    jsonvalidate,
+    shiny
 Suggests: 
     testthat (>= 3.0.0)
 Config/testthat/edition: 3

NAMESPACE

@@ -9,3 +9,8 @@ export(read_in)
 export(shiny_dd)
 export(validate_Rd)
 import(tools)
+importFrom(hexSticker,sticker)
+importFrom(jsonlite,fromJSON)
+importFrom(jsonlite,toJSON)
+importFrom(jsonvalidate,json_validate)
+importFrom(shiny,runApp)

R/add_object.R

@@ -3,6 +3,8 @@
 #' @param input_list A list of fields corresponding to entries. Must include
 #'  \code{name,description,Examples, Units, Rationale, Alternatives, Range of possible values}
 #' @return An R list in the JSON format which includes the new term.
+#' @importFrom jsonlite fromJSON toJSON
+#' @importFrom jsonvalidate json_validate
 #' @export
 add_object <- function(input_list) {
   json_obj <- jsonlite::fromJSON(system.file("extdata","top20.json", package = "stockassessmentdictionary"))

R/make_hex.R

@@ -1,3 +1,7 @@
+#' Create a hexagonal sticker for the 'fishdictionary' package.
+#'
+#' @importFrom hexSticker sticker
+#' @return The function does not return any value but creates a hexagonal sticker image.
 make_hex <- function(){
   hexSticker::sticker(paste0("./static/pictures/", c("nounbook.png","nounfish.png")), 
                       package="fishdictionary", p_size=20, s_x=c(1,1), s_y=c(.4,.9), 

R/shiny_dd.r

@@ -1,6 +1,7 @@
 #' Run the data dictionary app
 #'
 #' Run the data dictionary app
+#' @importFrom shiny runApp
 #' @export
 #' @param browse Logical. Use browser for running Shiny app.
 #' @examples

R/validate_Rd.R

@@ -13,7 +13,7 @@ validate_Rd <- function(Rd_file) {
   if (is.null(Rd_file)) stop("Please provide the path to the R documentation (Rd) file.")
 
   Rd <- tools::parse_Rd(Rd_file)
-  tags <- tools:::RdTags(Rd)
+  tags <- lapply(Rd, attr, "Rd_tag")
 
   # Validate name
   name <- Rd[[which(tags == "\\name")]]