Skip to content

Commit

Permalink
implement fixes following CRAN comments
Browse files Browse the repository at this point in the history
  • Loading branch information
e-kotov committed Sep 3, 2024
1 parent c2e15d7 commit dea2098
Show file tree
Hide file tree
Showing 7 changed files with 56 additions and 16 deletions.
12 changes: 9 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
15 changes: 12 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@
Package: flowmapblue
Title: Flow Map Rendering
Version: 0.0.1
Version: 0.0.2
Authors@R: c(
person("Ilya", "Boyandin", , "[email protected]", role = c("aut", "cph"),
comment = c(ORCID = "0000-0001-5585-7587")),
person("Egor", "Kotov", , "[email protected]", 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/
Expand Down
8 changes: 8 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -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.
14 changes: 11 additions & 3 deletions R/flowmapblue.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -77,7 +77,7 @@
},
"SystemRequirements": null
},
"fileSize": "4548.982KB",
"fileSize": "4551.297KB",
"citation": [
{
"@type": "SoftwareSourceCode",
Expand Down
4 changes: 2 additions & 2 deletions inst/schemaorg.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -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",
Expand Down
13 changes: 11 additions & 2 deletions man/flowmapblue-shiny.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit dea2098

Please sign in to comment.