Merge pull request #15 from rwoldford/master

Updated to return class on value of zenplot()

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: zenplots
-Version: 1.0.4.999
+Version: 1.0.4
 Encoding: UTF-8
 Title: Zigzag Expanded Navigation Plots
 Description: Graphical tools for visualizing high-dimensional data along a path
@@ -24,5 +24,5 @@ License: GPL-2 | GPL-3
 NeedsCompilation: yes
 VignetteBuilder: knitr, rmarkdown
 Repository: CRAN
-Date: 2021-05-13
+Date: 2021-09-08
 RoxygenNote: 7.1.1

NEWS.md

@@ -0,0 +1,17 @@
+# zenplots 1.0.4
+
+* zenplot now (invisibly) returns a list with two extra classes
+
+  - `zenplot` to identify that the structure is a zenplot
+  - one of `zengraphics`, `zenGrid`, or `zenLoon` to indicate which graphics
+    package was used.
+  - allows `loon` zenplots to be turned into ggplots via package `loon.ggplot`
+
+  documentation updated accordingly.
+
+* updated documentation on `zenpath` to mention that `pairs` must describe
+  a connected graph.
+
+# zenplots 1.0.3
+
+- CRAN release 

R/zenpath.R

@@ -424,7 +424,10 @@ indexData <- function(x, indices)
 ##'
 ##' @param pairs a two-column \code{\link{matrix}} containing (row-wise)
 ##' the pairs of connected variables to be sorted according to the
-##' weights. The \code{pairs} argument is only used for the \code{method}s
+##' weights. Note that the resulting graph must be connected 
+##' (i.e. any variable can be reached from any other variable 
+##' following the connections given by \code{pairs}).
+##' The \code{pairs} argument is only used for the \code{method}s
 ##' \code{greedy.weighted} and \code{strictly.weighted} and can be
 ##' \code{NULL} (in which case a default is constructed in lexicographical order).
 ##' @param method \code{\link{character}} string indicating the sorting

R/zenplot.R

@@ -270,7 +270,12 @@ unfold <- function(nfaces, turns = NULL,
 ##'        \code{plot2d}. If you need to pass certain arguments only to one
 ##'        of them, say, \code{plot2d}, consider providing your own
 ##'        \code{plot2d}; see the examples below.
-##' @return (besides plotting) invisibly returns a list containing at least
+##' @return (besides plotting) invisibly returns a list having additional classnames
+##'        marking it as a zenplot and a zenPkg object (with Pkg being one of Graphics,
+##'        Grid, or Loon, so as to identify the
+##'        package used to construct the plot).  
+##'        
+##'        As a list it contains at least
 ##'        the path and layout (see \code{\link{unfold}} for details).
 ##'
 ##'        Depending on the graphics package \code{pkg} used, the returned list

_pkgdown.yml

@@ -26,6 +26,10 @@ navbar:
       - text: measuring association of random vectors
         href: https://www.sciencedirect.com/science/article/pii/S0047259X1830023X
 
+    - text: Change log
+      href: news/index.html
+
+
   right:
     - icon: fa-github fa-lg
       href: https://github.com/great-northern-diver/zenplots
@@ -35,8 +39,6 @@ development:
 
 destination: ./docs/
 
-
-
 reference:
   - title: zenplots
     desc:  Main functions for creating zenplots
@@ -172,3 +174,4 @@ reference:
     - n2dcols_aux
     - num_cols
     - turn_checker
+

docs/articles/intro_files/header-attrs-2.10/header-attrs.js

@@ -0,0 +1,12 @@
+// Pandoc 2.9 adds attributes on both header and div. We remove the former (to
+// be compatible with the behavior of Pandoc < 2.8).
+document.addEventListener('DOMContentLoaded', function(e) {
+  var hs = document.querySelectorAll("div.section[class*='level'] > :first-child");
+  var i, h, a;
+  for (i = 0; i < hs.length; i++) {
+    h = hs[i];
+    if (!/^h[1-6]$/i.test(h.tagName)) continue;  // it should be a header h1-h6
+    a = h.attributes;
+    while (a.length > 0) h.removeAttribute(a[0].name);
+  }
+});

docs/articles/selected_features_files/header-attrs-2.10/header-attrs.js

@@ -0,0 +1,12 @@
+// Pandoc 2.9 adds attributes on both header and div. We remove the former (to
+// be compatible with the behavior of Pandoc < 2.8).
+document.addEventListener('DOMContentLoaded', function(e) {
+  var hs = document.querySelectorAll("div.section[class*='level'] > :first-child");
+  var i, h, a;
+  for (i = 0; i < hs.length; i++) {
+    h = hs[i];
+    if (!/^h[1-6]$/i.test(h.tagName)) continue;  // it should be a header h1-h6
+    a = h.attributes;
+    while (a.length > 0) h.removeAttribute(a[0].name);
+  }
+});