Skip to content

Commit e512a1c

Browse files
e-kotove-kotov
authored
Merge pull request #11 from FlowmapBlue/10-release-flowmapblue-001
implement fixes following CRAN comments
2 parents c2e15d7 + 28a6433 commit e512a1c

11 files changed

Lines changed: 83 additions & 28 deletions

‎CITATION.cff‎

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

‎CRAN-SUBMISSION‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
Version: 0.0.1
2-
Date: 2024-08-30 12:36:17 UTC
3-
SHA: e15b3d4fa7c9e50db01b4ecaa26df5dfdf2fa98c
1+
Version: 0.0.2
2+
Date: 2024-09-03 17:01:12 UTC
3+
SHA: 0b9fc1d68b38a66a86a5b9adb5cc2631fdb8e46e

‎DESCRIPTION‎

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

‎NEWS.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
# flowmapblue 0.0.2
2+
3+
* Fixed DESCRIPTION
4+
5+
* Improved documentation for `flowmapblueOutput` and `renderFlowmapblue`
6+
7+
* Fixed missing `\value` tags in the documentation
8+
19
# flowmapblue 0.0.1
210

311
* Initial CRAN submission.

‎R/flowmapblue.R‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,15 +148,23 @@ flowmapblue <- function(
148148
#' Output and render functions for using flowmapblue within Shiny
149149
#' applications and interactive Rmd documents.
150150
#'
151-
#' @param outputId output variable to read from
152-
#' @param width,height Must be a valid CSS unit (like \code{'100\%'},
151+
#' @param outputId output variable to read from.
152+
#' @param width,height Must be a valid CSS unit (like \code{'100\%'},
153153
#' \code{'400px'}, \code{'auto'}) or a number, which will be coerced to a
154154
#' string and have \code{'px'} appended.
155-
#' @param expr An expression that generates a flowmapblue
155+
#' @param expr An expression that generates a `flowmapblue` widget.
156156
#' @param env The environment in which to evaluate \code{expr}.
157157
#' @param quoted Is \code{expr} a quoted expression (with \code{quote()})? This
158158
#' is useful if you want to save an expression in a variable.
159159
#'
160+
#' @return
161+
#' \describe{
162+
#' \item{\code{flowmapblueOutput}}{Returns a `shiny.tag.list` object that can be included in a Shiny UI to display the `flowmapblue` widget.}
163+
#' \item{\code{renderFlowmapblue}}{Returns a `shiny.render.function` that is used to generate the `flowmapblue` widget on the server side in a Shiny application.}
164+
#' }
165+
#'
166+
#' @seealso \code{\link[htmlwidgets:shinyWidgetOutput]{shinyWidgetOutput}}, \code{\link[htmlwidgets:shinyRenderWidget]{shinyRenderWidget}}
167+
#'
160168
#' @name flowmapblue-shiny
161169
#'
162170
#' @export

‎README.md‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,21 @@ alt="R-CMD-check" /></a> <!-- badges: end -->
1212

1313
WORK IN PROGRESS
1414

15-
This is a [Flowmap.blue](https://www.flowmap.blue/) widget for R. It
16-
produces an interactive flow map representing numbers of movements
17-
between locations (origin-destination data).
18-
19-
You might also consider using this pure R flowmapping library:
20-
https://github.com/JohMast/flowmapper
15+
This is a [Flowmap.blue](https://www.flowmap.blue/) widget for R. Create
16+
interactive flow maps using
17+
[`FlowmapBlue`](https://github.com/FlowmapBlue/FlowmapBlue) TypeScript
18+
library, which is a free tool for representing aggregated numbers of
19+
movements between geographic locations as flow maps. It is used to
20+
visualize urban mobility, commuting behavior, bus, subway and air
21+
travels, bicycle sharing, human and bird migration, refugee flows,
22+
freight transportation, trade, supply chains, scientific collaboration,
23+
epidemiological and historical data and many other topics. The package
24+
allows to either create standalone flow maps in form of ‘htmlwidgets’
25+
and save them in ‘HTML’ files, or integrate flow maps into ‘Shiny’
26+
applications.
27+
28+
You might also consider using this pure R flowmapping library based on
29+
`ggplot2`: https://github.com/JohMast/flowmapper
2130

2231
![](man/figures/demo.png)
2332

‎README.qmd‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,9 @@ default-image-extension: ""
1515

1616
WORK IN PROGRESS
1717

18-
This is a [Flowmap.blue](https://www.flowmap.blue/) widget for R.
19-
It produces an interactive flow map representing numbers of movements between locations (origin-destination data).
18+
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.
2019

21-
You might also consider using this pure R flowmapping library: https://github.com/JohMast/flowmapper
20+
You might also consider using this pure R flowmapping library based on `ggplot2`: https://github.com/JohMast/flowmapper
2221

2322
![](man/figures/demo.png)
2423

‎codemeta.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
33
"@type": "SoftwareSourceCode",
44
"identifier": "flowmapblue",
5-
"description": "Rendering interactive flow maps to visualize numbers of movements between locations (origin-destination data).",
5+
"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.",
66
"name": "flowmapblue: Flow Map Rendering",
77
"relatedLink": "https://flowmapblue.github.io/flowmapblue.R/",
88
"codeRepository": "https://github.com/FlowmapBlue/flowmapblue.R",
99
"issueTracker": "https://github.com/FlowmapBlue/flowmapblue.R/issues",
1010
"license": "https://spdx.org/licenses/MIT",
11-
"version": "0.0.1",
11+
"version": "0.0.2",
1212
"programmingLanguage": {
1313
"@type": "ComputerLanguage",
1414
"name": "R",
@@ -77,7 +77,7 @@
7777
},
7878
"SystemRequirements": null
7979
},
80-
"fileSize": "4548.982KB",
80+
"fileSize": "4551.882KB",
8181
"citation": [
8282
{
8383
"@type": "SoftwareSourceCode",

‎cran-comments.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
## Re-submission
2+
3+
* Expanded DESCRIPTION
4+
5+
* Improved documentation for `flowmapblueOutput` and `renderFlowmapblue`
6+
7+
18
## R CMD check results
29

310
0 errors | 0 warnings | 2 notes

‎inst/schemaorg.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"familyName": "Boyandin",
1515
"givenName": "Ilya"
1616
},
17-
"description": "Rendering interactive flow maps to visualize numbers of movements between locations (origin-destination data).",
17+
"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.",
1818
"license": "https://spdx.org/licenses/MIT",
1919
"name": "flowmapblue: Flow Map Rendering",
2020
"programmingLanguage": {
@@ -23,7 +23,7 @@
2323
"url": "https://r-project.org"
2424
},
2525
"runtimePlatform": "R version 4.4.1 (2024-06-14)",
26-
"version": "0.0.1"
26+
"version": "0.0.2"
2727
},
2828
{
2929
"id": "https://doi.org/10.32614/CRAN.package.flowmapblue",

0 commit comments

Comments
 (0)