Merge pull request #1 from Bruceshark/main

init GWalkR

Author: ObservedObserver

.Rbuildignore

@@ -0,0 +1,7 @@
+^GWalkR\.Rproj$
+^\.Rproj\.user$
+^web_app
+^graphic-walker
+^GWalkR.Rcheck
+^\.vscode$
+^LICENSE$

.gitignore

@@ -47,3 +47,10 @@ po/*~
 
 # RStudio Connect folder
 rsconnect/
+
+.DS_Store
+node_modules
+
+.vscode/
+
+inst/htmlwidgets/lib/gwalkr

DESCRIPTION

@@ -0,0 +1,17 @@
+Package: GWalkR
+Title: Interactive Exploratory Data Analysis Tool in R
+Version: 0.1.0
+Authors@R: c(
+    person("Yue", "Yu", , "[email protected]", role = c("aut", "cre"),
+           comment = c(ORCID = "0000-0002-9302-0793")),
+    person("Kanaries Data Inc.", role = c("cph", "fnd")))
+Maintainer: Yue Yu <[email protected]>
+Description: Simplify your R data analysis and data visualization workflow, by turning your data frame into a Tableau-style User Interface for visual exploration.
+License: Apache License (>= 2)
+Encoding: UTF-8
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.2.3
+URL: https://github.com/Kanaries/GWalkR/
+Imports: 
+    htmlwidgets,
+    jsonlite,

GWalkR.Rproj

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

NAMESPACE

@@ -0,0 +1,6 @@
+# Generated by roxygen2: do not edit by hand
+
+export(gwalkr)
+export(gwalkrOutput)
+export(renderGwalkr)
+import(htmlwidgets)

R/data_parser.R

@@ -0,0 +1,44 @@
+raw_fields <- function(df) {
+  cols <- colnames(df)
+  props <- lapply(seq_along(cols), function(i) {
+    infer_prop(cols[i], i, df)
+  })
+  return(props)
+}
+
+infer_prop <- function(col, i = NULL, df) {
+  s <- df[[col]]
+  semantic_type <- infer_semantic(s)
+  analytic_type <- infer_analytic(s)
+  prop <- list(
+    fid = col,
+    name = col,
+    semanticType = semantic_type,
+    analyticType = analytic_type
+  )
+  return(prop)
+}
+
+infer_semantic <- function(s) {
+  v_cnt <- length(unique(s))
+  kind <- class(s)
+  if (any(sapply(c('numeric', 'integer'), inherits, x = s)) & v_cnt > 16) {
+    return('quantitative')
+  } else if (any(sapply(c('POSIXct', 'POSIXlt', 'Date'), inherits, x = s))) {
+    return('temporal')
+  } else if (inherits(s, 'ordered')) {
+    return('ordinal')
+  } else {
+    return('nominal')
+  }
+}
+
+infer_analytic <- function(s) {
+  v_cnt <- length(unique(s))
+  kind <- class(s)
+  if ((inherits(s, 'numeric')) | (inherits(s, 'integer') & v_cnt > 16)) {
+    return('measure')
+  } else {
+    return('dimension')
+  }
+}

R/gwalkr.R

@@ -0,0 +1,62 @@
+#' Create GWalkR Interface in "Viewer"
+#'
+#' Use this function to create a GWalkR interface from a given data frame in your "Viewer" window, and start your data exploration! Please make sure the width and the height of your "Viewer" window are large enough.
+#'
+#' @import htmlwidgets
+#'
+#' @param data A data frame to be visualized in the GWalkR. The data frame should not be empty.
+#' @param lang A character string specifying the language for the widget. Possible values are "en" (default), "ja", "zh".
+#'
+#' @examples
+#' \dontrun{
+#' data(mtcars)
+#' gwalkr(mtcars)
+#' }
+#'
+#' @export
+gwalkr <- function(data, lang = "en") {
+  if (!is.data.frame(data)) stop("data must be a data frame")
+  lang <- match.arg(lang, choices = c("en", "ja", "zh"))
+
+  # forward options using x
+  x = list(
+    dataSource = jsonlite::toJSON(data, pretty=TRUE),
+    rawFields = raw_fields(data),
+    i18nLang = lang
+  )
+
+  # create widget
+  htmlwidgets::createWidget(
+    name = 'gwalkr',
+    x,
+    package = 'GWalkR'
+  )
+}
+
+#' Shiny bindings for gwalkr
+#'
+#' Output and render functions for using gwalkr 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 gwalkr
+#' @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 gwalkr-shiny
+#'
+#' @export
+gwalkrOutput <- function(outputId, width = '100%', height = '400px'){
+  htmlwidgets::shinyWidgetOutput(outputId, 'gwalkr', width, height, package = 'GWalkR')
+}
+
+#' @rdname gwalkr-shiny
+#' @export
+renderGwalkr <- function(expr, env = parent.frame(), quoted = FALSE) {
+  if (!quoted) { expr <- substitute(expr) } # force quoted
+  htmlwidgets::shinyRenderWidget(expr, gwalkrOutput, env, quoted = TRUE)
+}

README.md

@@ -1,2 +1,43 @@
-# GWalkR
-R binding of graphic-walker, use table style drag and drop UI interface to build visualization in R.
+# GWalkR: Your One-Stop R Package for Exploratory Data Analysis with Visualization
+
+Start Exploratory Data Analysis (EDA) in R with a Single Line of Code!
+[GWalkR](https://github.com/Kanaries/GWalkR) is an interactive Exploratory Data Analysis (EDA) Tool in R.
+It integrates the htmlwidgets with [Graphic Walker](https://github.com/Kanaries/graphic-walker).
+It can can simplify your R data analysis and data visualization workflow, by turning your data frame into a Tableau-style User Interface for visual exploration.
+
+<img width="1437" alt="image" src="https://github.com/Bruceshark/GWalkR/assets/33870780/26967dda-57c0-4abd-823c-63037c8f5168">
+
+
+## Getting Started
+
+### Setup GWalkR
+
+#### Through Package Archive File (.tar.gz)
+
+First, download the package archive file `GWalkR_0.1.0.tar.gz` from the Github release.
+Open R Studio, click "Install" in the "Packages" window, and select "Package Archive File (.tgz; .tar.gz)" in the "Install from". Then, select the archive in your file system and click "Install".
+
+#### Through Running R Script
+
+Alternatively, you can run the following R code in your script to download without a lot of clicking.
+
+```R
+url <- "https://github.com/Bruceshark/GWalkR/releases/download/preview/GWalkR_0.1.0.tar.gz"
+destfile <- "GWalkR_0.1.0.tar.gz"
+download.file(url, destfile)
+install.packages(destfile, repos = NULL, type = "source")
+```
+
+#### Through CRAN
+
+To be supported soon. Stay tuned!
+
+
+### Start Your Data Exploration in a Single Line of Code
+
+```R
+library(GWalkR)
+data(iris)
+gwalkr(iris)
+```
+

inst/htmlwidgets/gwalkr.js

@@ -0,0 +1,27 @@
+HTMLWidgets.widget({
+
+  name: 'gwalkr',
+
+  type: 'output',
+
+  factory: function(el, width, height) {
+
+    // TODO: define shared variables for this instance
+
+    return {
+
+      renderValue: function(x) {
+
+        GWalkRApp(x, el.id);
+
+      },
+
+      resize: function(width, height) {
+
+        // TODO: code to re-render the widget with a new size
+
+      }
+
+    };
+  }
+});

inst/htmlwidgets/gwalkr.yaml

@@ -0,0 +1,8 @@
+dependencies:
+  - name: gwalkr
+    version: 1.0.0
+    src: htmlwidgets/lib/gwalkr
+    script:
+      - gwalkr-app.iife.js
+      - style.css
+      - vite.svg