From ec13bd1c4b1f1b0aba20b07c5a0b451bab36d243 Mon Sep 17 00:00:00 2001 From: "Martin R. Smith" <1695515+ms609@users.noreply.github.com> Date: Thu, 22 Aug 2024 14:35:57 +0100 Subject: [PATCH] Document VisMatch parameters --- DESCRIPTION | 2 +- NEWS.md | 4 +++- man/VisualizeMatching.Rd | 10 +++++++++- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index a244aee4a..a3dc1737f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: TreeDist Type: Package Title: Calculate and Map Distances Between Phylogenetic Trees -Version: 2.8.0.9000 +Version: 2.8.0.9001 Authors@R: c(person("Martin R.", "Smith", email = "martin.smith@durham.ac.uk", role = c("aut", "cre", "cph", "prg"), diff --git a/NEWS.md b/NEWS.md index b5a250748..423045cb6 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,5 +1,7 @@ -# TreeDist 2.8.0.9000 (development) +# TreeDist 2.8.0.9001 (development) +- `VisualizeMatching()` allows more control over output format + ([#124](https://github.com/ms609/TreeDist/issues/124)) - `SpectralEigens()` returns correct eigenvalues (smallest was overlooked) - `SpectralEigens()` handles values of `nEig` larger than the input diff --git a/man/VisualizeMatching.Rd b/man/VisualizeMatching.Rd index 689af2562..6740b34e0 100644 --- a/man/VisualizeMatching.Rd +++ b/man/VisualizeMatching.Rd @@ -14,7 +14,9 @@ VisualizeMatching( Plot = plot.phylo, matchZeros = TRUE, plainEdges = FALSE, - edge.cex = 0.8, + edge.cex = par("cex"), + value.cex = edge.cex * 0.8, + edge.frame = "rect", edge.width = 1, edge.color = "black", show.edgelabels = TRUE, @@ -43,6 +45,12 @@ similarity of the associated splits (\code{FALSE}).} \item{edge.cex}{Character expansion for edge labels.} +\item{value.cex}{Character expansion for values on edge labels.} + +\item{edge.frame}{Character specifying the kind of frame to be printed around +the text of the edge labels. Choose an abbreviation of \code{"rect"}, \code{"circle"}, +or \code{"none"}.} + \item{edge.width, edge.color, \dots}{Additional parameters to send to \code{Plot()}.} } \description{