Merge pull request #9 from FlowmapBlue/prep-for-CRAN-release

Cleanup before CRAN release, new feature to handle time column

.Rbuildignore

@@ -1,2 +1,16 @@
 ^flowmapblue\.Rproj$
 ^\.Rproj\.user$
+^.idea$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
+^CITATION\.cff$
+^codemeta\.json$
+^vignettes/webmedia$
+^vignettes/.quarto$
+^.github$
+^README.qmd$
+^cran-comments\.md$
+^data-raw$
+^man/figures/opengraph-card.png$
+^LICENSE.md$

.github/workflows/R-CMD-check.yaml

@@ -0,0 +1,53 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  workflow_dispatch:
+
+name: R-CMD-check
+
+permissions: read-all
+
+jobs:
+  R-CMD-check:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: macos-latest,   r: 'release'}
+          - {os: windows-latest, r: 'release'}
+          - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
+          - {os: ubuntu-latest,   r: 'release'}
+          - {os: ubuntu-latest,   r: 'oldrel-1'}
+
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::rcmdcheck
+          needs: check
+
+      - uses: r-lib/actions/check-r-package@v2
+        with:
+          upload-snapshots: true
+          build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'

.github/workflows/pkgdown.yaml

@@ -0,0 +1,50 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+permissions: read-all
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -1,3 +1,17 @@
 .Rhistory
 .Rproj.user
 .idea
+
+# macOS artifacts
+.DS_Store
+._.DS_Store
+**/.DS_Store
+**/._.DS_Store
+
+/.quarto/
+.Renviron
+/doc/
+/docs/
+/Meta/
+vignettes/.quarto
+docs

CITATION.cff

@@ -0,0 +1,100 @@
+# --------------------------------------------
+# CITATION file created with {cffr} R package
+# See also: https://docs.ropensci.org/cffr/
+# --------------------------------------------
+
+cff-version: 1.2.0
+message: 'To cite package "flowmapblue" in publications use:'
+type: software
+license: MIT
+title: 'flowmapblue: Flow Map Rendering'
+version: 0.0.1
+doi: 10.32614/CRAN.package.flowmapblue
+abstract: Rendering interactive flow maps to visualize numbers of movements between
+  locations (origin-destination data).
+authors:
+- family-names: Boyandin
+  given-names: Ilya
+  email: ilya@boyandin.me
+  orcid: https://orcid.org/0000-0001-5585-7587
+- family-names: Kotov
+  given-names: Egor
+  email: kotov.egor@gmail.com
+  orcid: https://orcid.org/0000-0001-6690-5345
+preferred-citation:
+  type: manual
+  title: Flowmap.blue widget for R
+  authors:
+  - family-names: Boyandin
+    given-names: Ilya
+    email: ilya@boyandin.me
+    orcid: https://orcid.org/0000-0001-5585-7587
+  year: '2024'
+  url: https://github.com/FlowmapBlue/flowmapblue.R
+  doi: 10.32614/CRAN.package.flowmapblue
+repository-code: https://github.com/FlowmapBlue/flowmapblue.R
+url: https://github.com/FlowmapBlue/flowmapblue.R
+contact:
+- family-names: Kotov
+  given-names: Egor
+  email: kotov.egor@gmail.com
+  orcid: https://orcid.org/0000-0001-6690-5345
+keywords:
+- datavis
+- mobility
+- mobility-data
+- movement-data
+- rstats
+- rstudio
+references:
+- type: software
+  title: 'R: A Language and Environment for Statistical Computing'
+  notes: Depends
+  url: https://www.R-project.org/
+  authors:
+  - name: R Core Team
+  institution:
+    name: R Foundation for Statistical Computing
+    address: Vienna, Austria
+  year: '2024'
+  version: '>= 2.10'
+- type: software
+  title: htmlwidgets
+  abstract: 'htmlwidgets: HTML Widgets for R'
+  notes: Imports
+  url: https://github.com/ramnathv/htmlwidgets
+  repository: https://CRAN.R-project.org/package=htmlwidgets
+  authors:
+  - family-names: Vaidyanathan
+    given-names: Ramnath
+  - family-names: Xie
+    given-names: Yihui
+  - family-names: Allaire
+    given-names: JJ
+  - family-names: Cheng
+    given-names: Joe
+    email: joe@posit.co
+  - family-names: Sievert
+    given-names: Carson
+    email: carson@posit.co
+    orcid: https://orcid.org/0000-0002-4958-2844
+  - family-names: Russell
+    given-names: Kenton
+  year: '2024'
+- type: software
+  title: quarto
+  abstract: 'quarto: R Interface to ''Quarto'' Markdown Publishing System'
+  notes: Suggests
+  url: https://quarto-dev.github.io/quarto-r/
+  repository: https://CRAN.R-project.org/package=quarto
+  authors:
+  - family-names: Allaire
+    given-names: JJ
+    email: jj@posit.co
+    orcid: https://orcid.org/0000-0003-0174-9868
+  - family-names: Dervieux
+    given-names: Christophe
+    email: cderv@posit.co
+    orcid: https://orcid.org/0000-0003-4474-2498
+  year: '2024'
+

DESCRIPTION

@@ -1,16 +1,26 @@
 Package: flowmapblue
-Title: Flow map rendering
+Title: Flow Map Rendering
 Version: 0.0.1
-Authors@R:
-    person(given = "Ilya",
-           family = "Boyandin",
-           role = c("aut", "cre"),
-           email = "ilya@boyandin.me",
-           comment = c(ORCID = "0000-0001-5585-7587"))
-Description: Rendering interactive flow maps to visualize numbers of movements between locations (origin-destination data).
-License: `use_mit_license()`
+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).
+License: MIT + file LICENSE
+URL: https://github.com/FlowmapBlue/flowmapblue.R
+BugReports: https://github.com/FlowmapBlue/flowmapblue.R/issues
+Depends: 
+    R (>= 2.10)
+Imports: 
+    htmlwidgets
+Suggests: 
+    quarto
+VignetteBuilder:
+    quarto
 Encoding: UTF-8
 LazyData: true
-Imports: htmlwidgets
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.1
+RoxygenNote: 7.3.2

LICENSE

@@ -1,18 +1,2 @@
-Copyright 2020 Ilya Boyandin
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+YEAR: 2020
+COPYRIGHT HOLDER: Ilya Boyandin

LICENSE.md

@@ -0,0 +1,20 @@
+# MIT License
+
+Copyright 2020 Ilya Boyandin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NEWS.md

@@ -0,0 +1,3 @@
+# flowmapblue 0.0.1
+
+* Initial CRAN submission.

R/data.R

@@ -0,0 +1,26 @@
+#' Swiss Locations Dataset
+#'
+#' A dataset containing geographic information about 26 locations in Switzerland. This data includes unique identifiers, names, and geographic coordinates (latitude and longitude) for each location.
+#'
+#' @format ## `ch_locations`
+#' A data frame with 26 rows and 4 columns:
+#' \describe{
+#'   \item{id}{A `character` vector representing the unique identifier for each Swiss location (e.g., "JU", "LU").}
+#'   \item{name}{A `character` vector representing the name of each location (e.g., "Jura", "Luzern").}
+#'   \item{lat}{A `numeric` vector representing the latitude of each location in WGS84 (EPSG: 4326) coordinate reference system.}
+#'   \item{lon}{A `numeric` vector representing the longitude of each location in WGS84 (EPSG: 4326) coordinate reference system.}
+#' }
+"ch_locations"
+
+#' Swiss Flows Dataset
+#'
+#' A dataset containing flow data between various locations in Switzerland. This data represents the flow counts between origin and destination locations, identified by their unique codes.
+#'
+#' @format ## `ch_flows`
+#' A data frame with 676 rows and 3 columns:
+#' \describe{
+#'   \item{origin}{A `character` vector representing the origin location identifier (must match the `id` in the `ch_locations` dataset).}
+#'   \item{dest}{A `character` vector representing the destination location identifier (must match the `id` in the `ch_locations` dataset).}
+#'   \item{count}{An `integer` vector representing the flow count between the origin and destination locations.}
+#' }
+"ch_flows"