Merge pull request #24 from visa/development

Development

packages/charts-R/DESCRIPTION

@@ -1,28 +1,31 @@
 Package: visachartR
 Version: 1.0.2
 Date: 2021-04-13
-Title: R Wrapper for Visa Chart Components
-Description: Provides a set of wrapper functions in R for Visa Chart Components.
+Title: Wrapper for 'Visa Chart Components'
+Description: Provides a set of wrapper functions for 'Visa Chart Components'.
   'Visa Chart Components' <https://github.com/visa/visa-chart-components> is an accessibility focused,
   framework agnostic set of data experience design systems components for the web.
-Authors@R: c(
-    person(family = "Visa Data Experience Team", role = c("aut", "cph", "fnd")),
-    person(given = "Christopher",
-           family = "DeMartini",
-           role = c("aut", "cre"),
-           email = "chris.demartini.npm@gmail.com"),
-    person(given = "Jaime",
-           family = "Tanner",
-           role = c("aut"),
-           email = "jaimeatanner@gmail.com"),
-    person(given = "Frank",
-           family = "Elavsky",
-           role = c("aut"),
-           email = "frankelavsky@gmail.com"),
-    person(given = "Wojtek",
-           family = "Kostelecki",
-           role = c("ctb"),
-           email = "wojtek.kostelecki@gmail.com"))
+Authors@R: 
+    c(person(given = "Christopher",
+             family = "DeMartini",
+             role = c("aut", "cre"),
+             email = "chris.demartini.npm@gmail.com"),
+      person(given = "Jaime",
+             family = "Tanner",
+             role = c("aut"),
+             email = "jaimeatanner@gmail.com"),
+      person(given = "Frank",
+             family = "Elavsky",
+             role = c("aut"),
+             email = "frankelavsky@gmail.com"),
+      person(given = "Wojtek",
+             family = "Kostelecki",
+             role = c("ctb"),
+             email = "wojtek.kostelecki@gmail.com"),
+      person(given = "Visa Data Experience Team",
+             role = c("aut", "fnd")),
+      person(given = "Visa, Inc.",
+               role = c("cph")))
 BugReports: https://github.com/visa/visa-chart-components/issues
 License: MIT + file LICENSE
 URL: https://github.com/visa/visa-chart-components/tree/master/packages/charts-R

packages/charts-R/R/alluvial_diagram.R

@@ -25,6 +25,7 @@
 #' @param props List(). A valid R list with additional property configurations, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/alluvial-diagram}{@visa/alluvial-diagram}
 #' @param ... All other props passed into the function will be passed through to the chart, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/alluvial-diagram}{@visa/alluvial-diagram}.
 #' @details To see all available options for the chart properties/API see \href{https://github.com/visa/visa-chart-components/tree/master/packages/alluvial-diagram}{@visa/alluvial-diagram}.
+#' @return a visaNodeLinkChart htmlwidget object for plotting an alluvial diagram
 #' @export
 #' @examples
 #' library(tidyverse)

packages/charts-R/R/bar_chart.R

@@ -23,6 +23,7 @@
 #' @param props List(). A valid R list with additional property configurations, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/bar-chart}{@visa/bar-chart}
 #' @param ... All other props passed into the function will be passed through to the chart, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/bar-chart}{@visa/bar-chart}.
 #' @details To see all available options for the chart properties/API see \href{https://github.com/visa/visa-chart-components/tree/master/packages/bar-chart}{@visa/bar-chart}.
+#' @return a visaChart htmlwidget object for plotting a bar chart
 #' @export
 #' @examples
 #' library(tidyverse)

packages/charts-R/R/circle_packing.R

@@ -22,6 +22,7 @@
 #' @param props List(). A valid R list with additional property configurations, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/circle-packing}{@visa/circle-packing}
 #' @param ... All other props passed into the function will be passed through to the chart, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/circle-packing}{@visa/circle-packing}.
 #' @details To see all available options for the chart properties/API see \href{https://github.com/visa/visa-chart-components/tree/master/packages/circle-packing}{@visa/circle-packing}.
+#' @return a visaChart htmlwidget object for plotting a circle packing plot
 #' @export
 #' @examples
 #' library(dplyr)

packages/charts-R/R/clustered_bar_chart.R

@@ -22,6 +22,7 @@
 #' @param props List(). A valid R list with additional property configurations, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/clustered-bar-chart}{@visa/clustered-bar-chart}
 #' @param ... All other props passed into the function will be passed through to the chart, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/clustered-bar-chart}{@visa/clustered-bar-chart}.
 #' @details To see all available options for the chart properties/API see \href{https://github.com/visa/visa-chart-components/tree/master/packages/clustered-bar-chart}{@visa/clustered-bar-chart}.
+#' @return a visaChart htmlwidget object for plotting a clustered bar chart
 #' @export
 #' @examples
 #' library(tidyverse)

packages/charts-R/R/dumbbell_plot.R

@@ -23,6 +23,7 @@
 #' @param props List(). A valid R list with additional property configurations, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/dumbbell-plot}{@visa/dumbbell-plot}
 #' @param ... All other props passed into the function will be passed through to the chart, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/dumbbell-plot}{@visa/dumbbell-plot}.
 #' @details To see all available options for the chart properties/API see \href{https://github.com/visa/visa-chart-components/tree/master/packages/dumbbell-plot}{@visa/dumbbell-plot}.
+#' @return a visaChart htmlwidget object for plotting a dumbbell plot
 #' @export
 #' @examples
 #' library(tidyverse)

packages/charts-R/R/heat_map.R

@@ -23,6 +23,7 @@
 #' @param props List(). A valid R list with additional property configurations, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/heat-map}{@visa/heat-map}
 #' @param ... All other props passed into the function will be passed through to the chart, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/heat-map}{@visa/heat-map}.
 #' @details To see all available options for the chart properties/API see \href{https://github.com/visa/visa-chart-components/tree/master/packages/heat-map}{@visa/heat-map}.
+#' @return a visaChart htmlwidget object for plotting a heat map
 #' @export
 #' @examples
 #' library(tidyverse)

packages/charts-R/R/line_chart.R

@@ -23,6 +23,7 @@
 #' @param props List(). A valid R list with additional property configurations, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/line-chart}{@visa/line-chart}
 #' @param ... All other props passed into the function will be passed through to the chart, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/line-chart}{@visa/line-chart}.
 #' @details To see all available options for the chart properties/API see \href{https://github.com/visa/visa-chart-components/tree/master/packages/line-chart}{@visa/line-chart}.
+#' @return a visaChart htmlwidget object for plotting a line chart
 #' @export
 #' @examples
 #' library(dplyr)

packages/charts-R/R/parallel_plot.R

@@ -23,6 +23,7 @@
 #' @param props List(). A valid R list with additional property configurations, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/parallel-plot}{@visa/parallel-plot}
 #' @param ... All other props passed into the function will be passed through to the chart, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/parallel-plot}{@visa/parallel-plot}.
 #' @details To see all available options for the chart properties/API see \href{https://github.com/visa/visa-chart-components/tree/master/packages/parallel-plot}{@visa/parallel-plot}.
+#' @return a visaChart htmlwidget object for plotting a parallel plot
 #' @export
 #' @examples
 #' library(dplyr)

packages/charts-R/R/pie_chart.R

@@ -22,14 +22,15 @@
 #' @param props List(). A valid R list with additional property configurations, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/pie-chart}{@visa/pie-chart}
 #' @param ... All other props passed into the function will be passed through to the chart, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/pie-chart}{@visa/pie-chart}.
 #' @details To see all available options for the chart properties/API see \href{https://github.com/visa/visa-chart-components/tree/master/packages/pie-chart}{@visa/pie-chart}.
+#' @return a visaChart htmlwidget object for plotting a pie chart
 #' @export
 #' @examples
 #' library(tidyverse)
-#' data.frame (HairEyeColor) %>% 
-#'  filter(Hair=="Blond", Sex=="Male") %>% 
-#'  mutate(blueEyes = if_else(Eye=="Blue", "Blue","Other")) %>% 
-#'  group_by(blueEyes, Hair, Sex) %>% 
-#'  summarise(FreqSum=sum(Freq), n=n()) %>% 
+#' data.frame (HairEyeColor) %>%
+#'  filter(Hair=="Blond", Sex=="Male") %>%
+#'  mutate(blueEyes = if_else(Eye=="Blue", "Blue","Other")) %>%
+#'  group_by(blueEyes, Hair, Sex) %>%
+#'  summarise(FreqSum=sum(Freq), n=n()) %>%
 #'  pie_chart(
 #'   "blueEyes",
 #'   "FreqSum",

packages/charts-R/R/scatter_plot.R

@@ -20,6 +20,7 @@
 #' @param props List(). A valid R list with additional property configurations, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/scatter-plot}{@visa/scatter-plot}
 #' @param ... All other props passed into the function will be passed through to the chart, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/scatter-plot}{@visa/scatter-plot}.
 #' @details To see all available options for the chart properties/API see \href{https://github.com/visa/visa-chart-components/tree/master/packages/scatter-plot}{@visa/scatter-plot}.
+#' @return a visaChart htmlwidget object for plotting a scatter plot
 #' @export
 #' @examples
 #' library(tidyverse)

packages/charts-R/R/stacked_bar_chart.R

@@ -22,6 +22,7 @@
 #' @param props List(). A valid R list with additional property configurations, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/stacked-bar-chart}{@visa/stacked-bar-chart}
 #' @param ... All other props passed into the function will be passed through to the chart, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/stacked-bar-chart}{@visa/stacked-bar-chart}.
 #' @details To see all available options for the chart properties/API see \href{https://github.com/visa/visa-chart-components/tree/master/packages/stacked-bar-chart}{@visa/stacked-bar-chart}.
+#' @return a visaChart htmlwidget object for plotting a stacked bar chart
 #' @export
 #' @examples
 #' library(dplyr)

packages/charts-R/R/visaChart.R

@@ -9,12 +9,13 @@
 #'
 #' Visa Chart Components wrapped in r htmlwidgets package
 #'
-#' @param tagName String. The custom web component HTML tag for the Visa Chart Component. Set by respective chart functions. 
+#' @param tagName String. The custom web component HTML tag for the Visa Chart Component. Set by respective chart functions.
 #' @param data a valid R data frame. See more details in respective component functions.
 #' @param propList a list of props, created by each component function, see \href{https://github.com/visa/visa-chart-components}{Visa Chart Components}.
-#' @param height Number. Height of chart container. 
+#' @param height Number. Height of chart container.
 #' @param width Number. Width of chart container.
 #' @param ... All other props passed into the function will be passed through to the chart.
+#' @return a visaChart htmlwidget object for creating a variety of plot types
 #' @import htmlwidgets
 #'
 #' @export
@@ -52,6 +53,7 @@ visaChart <- function(tagName, data, propList, width = NULL, height = NULL, ...)
 #' @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 a Shiny output or render function for visaChart htmlwidgets
 #'
 #' @name visaChart-shiny
 #'

packages/charts-R/R/visaNodeLinkChart.R

@@ -9,13 +9,14 @@
 #'
 #' Visa Chart Components wrapped in r htmlwidgets package
 #'
-#' @param tagName String. The custom web component HTML tag for the Visa Chart Component. Set by respective chart functions. 
+#' @param tagName String. The custom web component HTML tag for the Visa Chart Component. Set by respective chart functions.
 #' @param linkData a valid R data frame. See more details in respective component functions.
 #' @param nodeData a valid R data frame. See more details in respective component functions.
 #' @param propList a list of props, created by each component function, see \href{https://github.com/visa/visa-chart-components}{Visa Chart Components}.
-#' @param height Number. Height of chart container. 
+#' @param height Number. Height of chart container.
 #' @param width Number. Width of chart container.
 #' @param ... All other props passed into the function will be passed through to the chart.
+#' @return a visaNodeLinkChart htmlwidget object for creating a variety of plot types
 #' @import htmlwidgets
 #'
 #' @export
@@ -54,6 +55,7 @@ visaNodeLinkChart <- function(tagName, linkData, nodeData, propList, width = NUL
 #' @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 a Shiny output or render function for visaNodeLinkChart htmlwidgets
 #'
 #' @name visaNodeLinkChart-shiny
 #'

packages/charts-R/R/world_map.R

@@ -27,12 +27,13 @@
 #' @param props List(). A valid R list with additional property configurations, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/world-map}{@visa/world-map}
 #' @param ... All other props passed into the function will be passed through to the chart, see all props for \href{https://github.com/visa/visa-chart-components/tree/master/packages/world-map}{@visa/world-map}.
 #' @details To see all available options for the chart properties/API see \href{https://github.com/visa/visa-chart-components/tree/master/packages/world-map}{@visa/world-map}.
+#' @return a visaChart htmlwidget object for plotting a world map
 #' @export
 #' @examples
 #' library(tidyverse)
-#' quakes %>% 
-#'  sample_n(100) %>% 
-#'  tibble::rowid_to_column() %>% 
+#' quakes %>%
+#'  sample_n(100) %>%
+#'  tibble::rowid_to_column() %>%
 #'  world_map(
 #'    markerAccessor = "rowid",
 #'    latitudeAccessor = "long",

packages/charts-R/cran-comments.md

@@ -0,0 +1,15 @@
+16 April 2021 Submission feedback response:
+
+- CPH role give to Visa, Inc.
+
+## Test environments
+
+- local R installation, R 4.0.5
+- ubuntu 16.04 (on travis-ci), R 4.0.5
+- win-builder (devel)
+
+## R CMD check results
+
+0 errors | 0 warnings | 1 note
+
+- This is a new release.