first commit

Author: ilyabo

.Rbuildignore

@@ -0,0 +1,2 @@
+^flowmapblue\.Rproj$
+^\.Rproj\.user$

.gitignore

@@ -0,0 +1,3 @@
+.Rhistory
+.Rproj.user
+.idea

DESCRIPTION

@@ -0,0 +1,15 @@
+Package: flowmapblue
+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()`
+Encoding: UTF-8
+LazyData: true
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.1.1

LICENSE

@@ -0,0 +1,18 @@
+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.

NAMESPACE

@@ -0,0 +1,6 @@
+# Generated by roxygen2: do not edit by hand
+
+export(flowmapblue)
+export(flowmapblueOutput)
+export(renderFlowmapblue)
+import(htmlwidgets)

R/flowmapblue.R

@@ -0,0 +1,62 @@
+#' <Add Title>
+#'
+#' <Add Description>
+#'
+#' @import htmlwidgets
+#'
+#' @export
+flowmapblue <- function(
+  locations, flows,
+  mapboxAccessToken = NULL,
+  clustering = TRUE,
+  animation = FALSE,
+  darkMode = FALSE
+) {
+
+  # pass the data and settings using 'x'
+  x <- list(
+    locations = locations,
+    flows = flows,
+    mapboxAccessToken = mapboxAccessToken,
+    clustering = clustering,
+    animation = animation,
+    darkMode = darkMode
+  )
+
+  # create widget
+  htmlwidgets::createWidget(
+    name = 'flowmapblue',
+    x,
+    width = NULL,
+    height = NULL,
+    package = 'flowmapblue'
+  )
+}
+
+#' Shiny bindings for flowmapblue
+#'
+#' 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\%'},
+#'   \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 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.
+#'
+#' @name flowmapblue-shiny
+#'
+#' @export
+flowmapblueOutput <- function(outputId, width = '100%', height = '400px'){
+  htmlwidgets::shinyWidgetOutput(outputId, 'flowmapblue', width, height, package = 'flowmapblue')
+}
+
+#' @rdname flowmapblue-shiny
+#' @export
+renderFlowmapblue <- function(expr, env = parent.frame(), quoted = FALSE) {
+  if (!quoted) { expr <- substitute(expr) } # force quoted
+  htmlwidgets::shinyRenderWidget(expr, flowmapblueOutput, env, quoted = TRUE)
+}

README.md

@@ -0,0 +1,21 @@
+# Flowmap.blue R widget
+
+This is an R widget for [Flowmap.blue](http://flowmap.blue).
+Rendering interactive flow maps to visualize numbers of movements between locations (origin-destination data).
+
+
+#### Installation
+
+You can install the package from GitHub as follows:
+
+    devtools::install_github("FlowmapBlue/flowmapblue.R")
+    library(flowmapblue);    
+    
+
+
+#### Usage
+
+    locations <- read.csv('https://gist.githubusercontent.com/ilyabo/a7b9701424257146b571149d92a14926/raw/2e9e1e9bcf64cf0090781b451037229ccb78e1b1/locations.csv')
+    flows <- read.csv('https://gist.githubusercontent.com/ilyabo/a7b9701424257146b571149d92a14926/raw/2e9e1e9bcf64cf0090781b451037229ccb78e1b1/flows.csv')
+    mapboxAccessToken = 'YOUR_MAPBOX_ACCESS_TOKEN'
+    flowmapblue(locations, flows, mapboxAccessToken, clustering=TRUE, darkMode=TRUE, animation=FALSE)

flowmapblue.Rproj

@@ -0,0 +1,22 @@
+Version: 1.0
+
+RestoreWorkspace: No
+SaveWorkspace: No
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes
+LineEndingConversion: Posix
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace

inst/htmlwidgets/flowmapblue.js

@@ -0,0 +1,31 @@
+HTMLWidgets.widget({
+
+  name: 'flowmapblue',
+
+  type: 'output',
+
+  factory: function(el, width, height) {
+
+    // TODO: define shared variables for this instance
+
+    return {
+
+      renderValue: function(x) {
+        flowmapBlue.init({
+          locations: HTMLWidgets.dataframeToD3(x.locations),
+          flows: HTMLWidgets.dataframeToD3(x.flows),
+          container: el,
+          mapboxAccessToken: x.mapboxAccessToken,
+          clustering: x.clustering,
+          animation: x.animation,
+          darkMode: x.darkMode,
+        });
+      },
+
+      resize: function(width, height) {
+        // TODO: code to re-render the widget with a new size
+      }
+
+    };
+  }
+});

inst/htmlwidgets/flowmapblue.yaml

@@ -0,0 +1,14 @@
+# (uncomment to add a dependency)
+# dependencies:
+#  - name:
+#    version:
+#    src:
+#    script:
+#    stylesheet:
+
+dependencies:
+  - name: flowmapblue
+    version: 0.0.1
+    src: htmlwidgets/lib
+    script:
+      - flowmap-blue.min.js