implement fixes following CRAN comments

Author: e-kotov

CITATION.cff

@@ -8,10 +8,16 @@ message: 'To cite package "flowmapblue" in publications use:'
 type: software
 license: MIT
 title: 'flowmapblue: Flow Map Rendering'
-version: 0.0.1
+version: 0.0.2
 doi: 10.32614/CRAN.package.flowmapblue
-abstract: Rendering interactive flow maps to visualize numbers of movements between
-  locations (origin-destination data).
+abstract: Create interactive flow maps using `FlowmapBlue` 'TypeScript' library <https://github.com/FlowmapBlue/FlowmapBlue>,
+  which is a free tool for representing aggregated numbers of movements between geographic
+  locations as flow maps. It is used to visualize urban mobility, commuting behavior,
+  bus, subway and air travels, bicycle sharing, human and bird migration, refugee
+  flows, freight transportation, trade, supply chains, scientific collaboration, epidemiological
+  and historical data and many other topics. The package allows to either create standalone
+  flow maps in form of 'htmlwidgets' and save them in 'HTML' files, or integrate flow
+  maps into 'Shiny' applications.
 authors:
 - family-names: Boyandin
   given-names: Ilya

DESCRIPTION

@@ -1,14 +1,23 @@
 Package: flowmapblue
 Title: Flow Map Rendering
-Version: 0.0.1
+Version: 0.0.2
 Authors@R: c(
     person("Ilya", "Boyandin", , "ilya@boyandin.me", role = c("aut", "cph"),
            comment = c(ORCID = "0000-0001-5585-7587")),
     person("Egor", "Kotov", , "kotov.egor@gmail.com", role = "cre",
            comment = c(ORCID = "0000-0001-6690-5345"))
   )
-Description: Rendering interactive flow maps to visualize numbers of
-    movements between locations (origin-destination data).
+Description: Create interactive flow maps using `FlowmapBlue` 'TypeScript'
+    library <https://github.com/FlowmapBlue/FlowmapBlue>, which is a free
+    tool for representing aggregated numbers of movements between
+    geographic locations as flow maps. It is used to visualize urban
+    mobility, commuting behavior, bus, subway and air travels, bicycle
+    sharing, human and bird migration, refugee flows, freight
+    transportation, trade, supply chains, scientific collaboration,
+    epidemiological and historical data and many other topics. The package
+    allows to either create standalone flow maps in form of 'htmlwidgets'
+    and save them in 'HTML' files, or integrate flow maps into 'Shiny'
+    applications.
 License: MIT + file LICENSE
 URL: https://github.com/FlowmapBlue/flowmapblue.R,
     https://flowmapblue.github.io/flowmapblue.R/

NEWS.md

@@ -1,3 +1,11 @@
+# flowmapblue 0.0.2
+
+* Fixed DESCRIPTION
+
+* Improved documentation for `flowmapblueOutput` and `renderFlowmapblue`
+
+* Fixed missing `\value` tags in the documentation
+
 # flowmapblue 0.0.1
 
 * Initial CRAN submission.

R/flowmapblue.R

@@ -148,15 +148,23 @@ flowmapblue <- function(
 #' Output and render functions for using flowmapblue within Shiny
 #' applications and interactive Rmd documents.
 #'
-#' @param outputId output variable to read from
-#' @param width,height Must be a valid CSS unit (like \code{'100\%'},
+#' @param outputId output variable to read from.
+#' @param width,height Must be a valid CSS unit (like \code{'100\%'}, 
 #'   \code{'400px'}, \code{'auto'}) or a number, which will be coerced to a
 #'   string and have \code{'px'} appended.
-#' @param expr An expression that generates a flowmapblue
+#' @param expr An expression that generates a `flowmapblue` widget.
 #' @param env The environment in which to evaluate \code{expr}.
 #' @param quoted Is \code{expr} a quoted expression (with \code{quote()})? This
 #'   is useful if you want to save an expression in a variable.
 #'
+#' @return
+#' \describe{
+#'   \item{\code{flowmapblueOutput}}{Returns a `shiny.tag.list` object that can be included in a Shiny UI to display the `flowmapblue` widget.}
+#'   \item{\code{renderFlowmapblue}}{Returns a `shiny.render.function` that is used to generate the `flowmapblue` widget on the server side in a Shiny application.}
+#' }
+#'
+#' @seealso \code{\link[htmlwidgets:shinyWidgetOutput]{shinyWidgetOutput}}, \code{\link[htmlwidgets:shinyRenderWidget]{shinyRenderWidget}}
+#'
 #' @name flowmapblue-shiny
 #'
 #' @export

codemeta.json

@@ -2,13 +2,13 @@
   "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
   "@type": "SoftwareSourceCode",
   "identifier": "flowmapblue",
-  "description": "Rendering interactive flow maps to visualize numbers of movements between locations (origin-destination data).",
+  "description": "Create interactive flow maps using `FlowmapBlue` 'TypeScript' library <https://github.com/FlowmapBlue/FlowmapBlue>, which is a free tool for representing aggregated numbers of movements between geographic locations as flow maps. It is used to visualize urban mobility, commuting behavior, bus, subway and air travels, bicycle sharing, human and bird migration, refugee flows, freight transportation, trade, supply chains, scientific collaboration, epidemiological and historical data and many other topics. The package allows to either create standalone flow maps in form of 'htmlwidgets' and save them in 'HTML' files, or integrate flow maps into 'Shiny' applications.",
   "name": "flowmapblue: Flow Map Rendering",
   "relatedLink": "https://flowmapblue.github.io/flowmapblue.R/",
   "codeRepository": "https://github.com/FlowmapBlue/flowmapblue.R",
   "issueTracker": "https://github.com/FlowmapBlue/flowmapblue.R/issues",
   "license": "https://spdx.org/licenses/MIT",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",
@@ -77,7 +77,7 @@
     },
     "SystemRequirements": null
   },
-  "fileSize": "4548.982KB",
+  "fileSize": "4551.297KB",
   "citation": [
     {
       "@type": "SoftwareSourceCode",

inst/schemaorg.json

@@ -14,7 +14,7 @@
         "familyName": "Boyandin",
         "givenName": "Ilya"
       },
-      "description": "Rendering interactive flow maps to visualize numbers of movements between locations (origin-destination data).",
+      "description": "Create interactive flow maps using `FlowmapBlue` 'TypeScript' library <https://github.com/FlowmapBlue/FlowmapBlue>, which is a free tool for representing aggregated numbers of movements between geographic locations as flow maps. It is used to visualize urban mobility, commuting behavior, bus, subway and air travels, bicycle sharing, human and bird migration, refugee flows, freight transportation, trade, supply chains, scientific collaboration, epidemiological and historical data and many other topics. The package allows to either create standalone flow maps in form of 'htmlwidgets' and save them in 'HTML' files, or integrate flow maps into 'Shiny' applications.",
       "license": "https://spdx.org/licenses/MIT",
       "name": "flowmapblue: Flow Map Rendering",
       "programmingLanguage": {
@@ -23,7 +23,7 @@
         "url": "https://r-project.org"
       },
       "runtimePlatform": "R version 4.4.1 (2024-06-14)",
-      "version": "0.0.1"
+      "version": "0.0.2"
     },
     {
       "id": "https://doi.org/10.32614/CRAN.package.flowmapblue",