diff --git a/.Rbuildignore b/.Rbuildignore index d5ffbb6..350778c 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,5 +1,7 @@ ^.*\.Rproj$ ^\.Rproj\.user$ .travis.yml +pkgdown/* _pkgdown.yml -docs +docs/* +README.md diff --git a/DESCRIPTION b/DESCRIPTION index ec3f08a..633a260 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,19 +1,25 @@ Package: diveR Type: Package -Title: Direct interactive visual exploration in R -Version: 0.1.0 +Title: Direct Interactive Visual Exploration in R +Version: 0.1.1 Authors@R: c(person(given = "R. Wayne", family = "Oldford", email = "rwoldford@uwaterloo.ca", role = c("aut", "cre")) ) -Description: 'diveR' is a set of `loon` related packages - (the great northern `diver` being the name for the Common `loon` -- Gavia immer). - The packages work together to provide a more complete Direct manipulation Interactive Visualization Environment - in `R`. It is designed for exploratory data analysis, particularly for data having many - dimensions but also provides the tools for the user to develop experimental interactive - displays of their own. - The package exists primarily to gather the related packages together and - to make it easy to install and load these multiple 'diveR' packages in a single step. +Description: The `diveR` package is the `looniverse` of + `loon` related packages - + the great northern `diveR` being another name (chiefly British) + for the Common `loon` (chiefly North American). + Together the `diveR` suite provides data analytic tools for + Direct Interactive Visual Exploration in R. + These tools work with and complement those of the `tidyverse` suite, + completing the graphics grammar of `ggplot2` to provide a grammar of interactive + graphics. + The suite provides many visual tools designed for moderately (100s of variables) + high dimensional data analysis, through `zenplots` and novel tools in `loon`, and + extends the `ggplot2` grammar to provide parallel coordinates, Andrews plots, and arbitrary + glyphs through `ggmulti`. + The `diveR` package gathers together and installs all these related packages. License: GPL-2 URL: https://github.com/great-northern-diver/diver/ BugReports: https://github.com/great-northern-diver/diver/issues @@ -28,12 +34,5 @@ Imports: ggmulti, loon.ggplot (>= 1.1.0), zenplots -Suggests: - knitr, - rmarkdown, - testthat -VignetteBuilder: - knitr Encoding: UTF-8 -LazyData: true RoxygenNote: 7.1.1 diff --git a/NEWS.md b/NEWS.md index 11d5ced..59172de 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,14 @@ +# diveR 0.1.1 + * first release for CRAN + * set of diveR packages: + + - `loon` + - `loon.data` + - `zenplots` + - `ggmulti` + - `loon.ggplot` + # diveR 0.1.0 + * just getting started diff --git a/R/attach.R b/R/attach.R index 2179b9a..4187221 100644 --- a/R/attach.R +++ b/R/attach.R @@ -1,7 +1,7 @@ ## Copied from file of the same name in tidyverse and modified for diveR diveRcore <- function() { - c("loon", "ggmulti", "loon.ggplot", "zenplots") + c("loon", "loon.data", "ggmulti", "loon.ggplot", "zenplots") } #, "loon.tourr") presentationPackages <- function() { @@ -35,6 +35,7 @@ diveR_message <- function(pkgs = diveRcore()) { collapse = "\n") l_web_msg <- paste0(l_web_msg, eg_msg, pkg_egs, "\n") } + l_web_msg } diveR_attach <- function() { diff --git a/README.md b/README.md index 1996a1a..1fa912c 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,48 @@ +# Direct Interactive Visual Exploration in R. ## diveR [![Build Status](https://travis-ci.org/great-northern-diver/diveR.svg?branch=master)](https://travis-ci.org/great-northern-diver/diveR) -'diveR' is a set of `loon` related packages (`diver` is another name for `loon`). +`diveR` is the `looniverse` of `loon` related packages, the **great northern diver** being another name (chiefly British) for the **Common loon** (chiefly North American). -The packages work together to provide a more complete **d**irect manipulation **i**nteractive **v**isualization **e**nvironment in **R**. - -It is designed for exploratory data analysis, particularly for data having many dimensions but also provides the tools for the user to develop experimental interactive displays of their own. - -The package exists primarily to gather the related packages together and to make it easy to install and load these multiple 'diveR' packages in a single step. -An introduction to `loon` is available [here](http://great-northern-diver.github.io/loon/articles/introduction.html). +Together the packages of the `diveR` suite provides data analytic tools for **d**irect **i**nteractive **v**isual **e**xploration in **R**. +These tools work with and complement those of the `tidyverse` suite, completing the graphics grammar of `ggplot2` to provide a **grammar of interactive graphics**. The suite provides many visual tools designed for moderately (100s of variables) high dimensional data analysis, through `zenplots` and novel tools in `loon`, and extends the `ggplot2` grammar to provide parallel coordinates, Andrews plots, and arbitrary glyphs through `ggmulti`. + +The `diveR` suite gathers together and installs all these related packages (documentation in links): + +- [loon](http://great-northern-diver.github.io/loon/). + + This is the backbone package that provides the interactive graphics. + +- [loon.data](http://great-northern-diver.github.io/loon.data/). + + Provides a rich collection of data sets to illustrate interactive graphics. It also includes several artificial data sets constructed for teaching purposes. + +- [zenplots](http://great-northern-diver.github.io/zenplots/). + + Extends + + - the base `graphics` package + - the `grid` graphics package + - the `loon` interactive graphics package + + to allow for the layout of alternating 1d and 2d plots. + + Provides compact displays for high dimensional data + (e.g., where pairs plots would be too small to be informative). + +- [ggmulti](http://great-northern-diver.github.io/ggmulti/). + + Extends the grammar of the `ggplot2` package to accommodate displays such as parallel coordinate and Andrews function plots for high dimensional data. + +- [loon.ggplot](http://great-northern-diver.github.io/loon.ggplot/). + + Provides a bridge between the elegant but static displays of `ggplot2` and the interactive direct manipulation graphics of `loon` + + Extends `ggplot2` to provide a **grammar of interactive graphics** + diff --git a/_pkgdown.yml b/_pkgdown.yml index 59b4c2f..193166a 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -18,7 +18,7 @@ navbar: - text: zenplots href: https://great-northern-diver.github.io/zenplots/ - - text: related packages + - text: other packages menu: - text: eikosograms href: https://rwoldford.github.io/eikosograms/ @@ -29,15 +29,12 @@ navbar: - icon: fa-github fa-lg href: https://github.com/great-northern-diver/diveR -development: - mode: release - -destination: docs/ - - reference: - - - title: DiveR only functions + - title: DiveR functions desc: Functions peculiar to diveR package contents: - diveR_packages + +development: + mode: release + diff --git a/docs/404.html b/docs/404.html index 4515514..2dc0dea 100644 --- a/docs/404.html +++ b/docs/404.html @@ -79,7 +79,7 @@ diveR - 0.1.0 + 0.1.1 @@ -111,7 +111,7 @@
  • diff --git a/docs/authors.html b/docs/authors.html index ef512cd..2d6afab 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -79,7 +79,7 @@ diveR - 0.1.0 + 0.1.1 @@ -111,7 +111,7 @@
  • diff --git a/docs/index.html b/docs/index.html index 6b984c1..0ff7754 100644 --- a/docs/index.html +++ b/docs/index.html @@ -5,7 +5,7 @@ -Direct interactive visual exploration in R • diveR +Direct Interactive Visual Exploration in R • diveR @@ -17,15 +17,21 @@ - - + +