From dea2098a00a896349d63b918d87f6b80625fc1a9 Mon Sep 17 00:00:00 2001 From: Egor Kotov Date: Tue, 3 Sep 2024 18:32:05 +0200 Subject: [PATCH 1/5] implement fixes following CRAN comments --- CITATION.cff | 12 +++++++++--- DESCRIPTION | 15 ++++++++++++--- NEWS.md | 8 ++++++++ R/flowmapblue.R | 14 +++++++++++--- codemeta.json | 6 +++--- inst/schemaorg.json | 4 ++-- man/flowmapblue-shiny.Rd | 13 +++++++++++-- 7 files changed, 56 insertions(+), 16 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 190b0a1..16fb897 100644 --- a/CITATION.cff +++ b/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 , + 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 diff --git a/DESCRIPTION b/DESCRIPTION index 87e33ad..b76ef6a 100644 --- a/DESCRIPTION +++ b/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 , 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/ diff --git a/NEWS.md b/NEWS.md index 9ab22a6..1f0c5fb 100644 --- a/NEWS.md +++ b/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. diff --git a/R/flowmapblue.R b/R/flowmapblue.R index b23287d..8a5f776 100644 --- a/R/flowmapblue.R +++ b/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 diff --git a/codemeta.json b/codemeta.json index 0d5763a..dbd6ba5 100644 --- a/codemeta.json +++ b/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 , 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", diff --git a/inst/schemaorg.json b/inst/schemaorg.json index 3bd877f..549f523 100644 --- a/inst/schemaorg.json +++ b/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 , 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", diff --git a/man/flowmapblue-shiny.Rd b/man/flowmapblue-shiny.Rd index 596562d..d5efed1 100644 --- a/man/flowmapblue-shiny.Rd +++ b/man/flowmapblue-shiny.Rd @@ -11,20 +11,29 @@ flowmapblueOutput(outputId, width = "100\%", height = "400px") renderFlowmapblue(expr, env = parent.frame(), quoted = FALSE) } \arguments{ -\item{outputId}{output variable to read from} +\item{outputId}{output variable to read from.} \item{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.} -\item{expr}{An expression that generates a flowmapblue} +\item{expr}{An expression that generates a \code{flowmapblue} widget.} \item{env}{The environment in which to evaluate \code{expr}.} \item{quoted}{Is \code{expr} a quoted expression (with \code{quote()})? This is useful if you want to save an expression in a variable.} } +\value{ +\describe{ +\item{\code{flowmapblueOutput}}{Returns a \code{shiny.tag.list} object that can be included in a Shiny UI to display the \code{flowmapblue} widget.} +\item{\code{renderFlowmapblue}}{Returns a \code{shiny.render.function} that is used to generate the \code{flowmapblue} widget on the server side in a Shiny application.} +} +} \description{ Output and render functions for using flowmapblue within Shiny applications and interactive Rmd documents. } +\seealso{ +\code{\link[htmlwidgets:shinyWidgetOutput]{shinyWidgetOutput}}, \code{\link[htmlwidgets:shinyRenderWidget]{shinyRenderWidget}} +} From 1eaf125e8bdd675b5f2e207f16094bcccaf16452 Mon Sep 17 00:00:00 2001 From: Egor Kotov Date: Tue, 3 Sep 2024 18:46:21 +0200 Subject: [PATCH 2/5] update README in line with the package DESCRIPTION file --- README.md | 21 +++++++++++++++------ README.qmd | 5 ++--- 2 files changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3bb4725..d3fa4b4 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,21 @@ alt="R-CMD-check" /> WORK IN PROGRESS -This is a [Flowmap.blue](https://www.flowmap.blue/) widget for R. It -produces an interactive flow map representing numbers of movements -between locations (origin-destination data). - -You might also consider using this pure R flowmapping library: -https://github.com/JohMast/flowmapper +This is a [Flowmap.blue](https://www.flowmap.blue/) widget for R. Create +interactive flow maps using +[`FlowmapBlue`](https://github.com/FlowmapBlue/FlowmapBlue) TypeScript +library, 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. + +You might also consider using this pure R flowmapping library based on +`ggplot2`: https://github.com/JohMast/flowmapper ![](man/figures/demo.png) diff --git a/README.qmd b/README.qmd index 5accc4e..85e5fbd 100644 --- a/README.qmd +++ b/README.qmd @@ -15,10 +15,9 @@ default-image-extension: "" WORK IN PROGRESS -This is a [Flowmap.blue](https://www.flowmap.blue/) widget for R. -It produces an interactive flow map representing numbers of movements between locations (origin-destination data). +This is a [Flowmap.blue](https://www.flowmap.blue/) widget for R. Create interactive flow maps using [`FlowmapBlue`](https://github.com/FlowmapBlue/FlowmapBlue) TypeScript library, 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. -You might also consider using this pure R flowmapping library: https://github.com/JohMast/flowmapper +You might also consider using this pure R flowmapping library based on `ggplot2`: https://github.com/JohMast/flowmapper ![](man/figures/demo.png) From 8e9b2ebf45d502c3fdaa0ca65fa08ce5907c2cba Mon Sep 17 00:00:00 2001 From: Egor Kotov Date: Tue, 3 Sep 2024 18:47:58 +0200 Subject: [PATCH 3/5] update metadata and cran comments --- codemeta.json | 2 +- cran-comments.md | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/codemeta.json b/codemeta.json index dbd6ba5..45f6116 100644 --- a/codemeta.json +++ b/codemeta.json @@ -77,7 +77,7 @@ }, "SystemRequirements": null }, - "fileSize": "4551.297KB", + "fileSize": "4551.882KB", "citation": [ { "@type": "SoftwareSourceCode", diff --git a/cran-comments.md b/cran-comments.md index 83b7e20..48e13c3 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,3 +1,10 @@ +## Re-submission + +* Expanded DESCRIPTION + +* Improved documentation for `flowmapblueOutput` and `renderFlowmapblue` + + ## R CMD check results 0 errors | 0 warnings | 2 notes From 0b9fc1d68b38a66a86a5b9adb5cc2631fdb8e46e Mon Sep 17 00:00:00 2001 From: Egor Kotov Date: Tue, 3 Sep 2024 19:00:38 +0200 Subject: [PATCH 4/5] update meta --- CITATION.cff | 2 +- DESCRIPTION | 2 +- codemeta.json | 2 +- inst/schemaorg.json | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 16fb897..4c2ecdd 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -10,7 +10,7 @@ license: MIT title: 'flowmapblue: Flow Map Rendering' version: 0.0.2 doi: 10.32614/CRAN.package.flowmapblue -abstract: Create interactive flow maps using `FlowmapBlue` 'TypeScript' library , +abstract: Create interactive flow maps using 'FlowmapBlue' 'TypeScript' library , 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 diff --git a/DESCRIPTION b/DESCRIPTION index b76ef6a..3e7d524 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -7,7 +7,7 @@ Authors@R: c( person("Egor", "Kotov", , "kotov.egor@gmail.com", role = "cre", comment = c(ORCID = "0000-0001-6690-5345")) ) -Description: Create interactive flow maps using `FlowmapBlue` 'TypeScript' +Description: Create interactive flow maps using 'FlowmapBlue' 'TypeScript' library , which is a free tool for representing aggregated numbers of movements between geographic locations as flow maps. It is used to visualize urban diff --git a/codemeta.json b/codemeta.json index 45f6116..7727aa5 100644 --- a/codemeta.json +++ b/codemeta.json @@ -2,7 +2,7 @@ "@context": "https://doi.org/10.5063/schema/codemeta-2.0", "@type": "SoftwareSourceCode", "identifier": "flowmapblue", - "description": "Create interactive flow maps using `FlowmapBlue` 'TypeScript' library , 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.", + "description": "Create interactive flow maps using 'FlowmapBlue' 'TypeScript' library , 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", diff --git a/inst/schemaorg.json b/inst/schemaorg.json index 549f523..80a449d 100644 --- a/inst/schemaorg.json +++ b/inst/schemaorg.json @@ -14,7 +14,7 @@ "familyName": "Boyandin", "givenName": "Ilya" }, - "description": "Create interactive flow maps using `FlowmapBlue` 'TypeScript' library , 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.", + "description": "Create interactive flow maps using 'FlowmapBlue' 'TypeScript' library , 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": { From 28a6433a501dec04875a36ace82d1451d0a4bb46 Mon Sep 17 00:00:00 2001 From: Egor Kotov Date: Tue, 3 Sep 2024 19:01:24 +0200 Subject: [PATCH 5/5] submitted to cran --- CRAN-SUBMISSION | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION index 50b4770..4ce6f0a 100644 --- a/CRAN-SUBMISSION +++ b/CRAN-SUBMISSION @@ -1,3 +1,3 @@ -Version: 0.0.1 -Date: 2024-08-30 12:36:17 UTC -SHA: e15b3d4fa7c9e50db01b4ecaa26df5dfdf2fa98c +Version: 0.0.2 +Date: 2024-09-03 17:01:12 UTC +SHA: 0b9fc1d68b38a66a86a5b9adb5cc2631fdb8e46e