From 20c144c5da78647df22ccb3b665fc07d448858e7 Mon Sep 17 00:00:00 2001 From: CJ Yetman Date: Sat, 16 Dec 2023 15:44:02 +0100 Subject: [PATCH] update docs --- DESCRIPTION | 2 +- man/as_tree_data.Rd | 18 +++++++++--------- man/sankey_network.Rd | 2 +- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 37ac459..70cc61c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -16,7 +16,7 @@ License: MIT + file LICENSE Encoding: UTF-8 LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.1.2 +RoxygenNote: 7.2.3 Imports: jsonlite (>= 0.9.6), methods, diff --git a/man/as_tree_data.Rd b/man/as_tree_data.Rd index dcc40d9..56ad53b 100644 --- a/man/as_tree_data.Rd +++ b/man/as_tree_data.Rd @@ -91,23 +91,23 @@ addressed by adding columns for formatting of the incoming link } \section{Methods (by class)}{ \itemize{ -\item \code{character}: Convert JSON from URL to \code{treenetdf} +\item \code{as_tree_data(character)}: Convert JSON from URL to \code{treenetdf} -\item \code{hclust}: Convert hclust objects to \code{treenetdf} +\item \code{as_tree_data(hclust)}: Convert hclust objects to \code{treenetdf} -\item \code{list}: Convert a nested list to \code{treenetdf} +\item \code{as_tree_data(list)}: Convert a nested list to \code{treenetdf} -\item \code{Node}: data.tree to \code{treenetdf} +\item \code{as_tree_data(Node)}: data.tree to \code{treenetdf} -\item \code{phylo}: Phylo tree to \code{treenetdf} +\item \code{as_tree_data(phylo)}: Phylo tree to \code{treenetdf} -\item \code{tbl_graph}: tbl_graph_to_treenetdf +\item \code{as_tree_data(tbl_graph)}: tbl_graph_to_treenetdf -\item \code{igraph}: Convert igraph tree to \code{treenetdf} +\item \code{as_tree_data(igraph)}: Convert igraph tree to \code{treenetdf} -\item \code{data.frame}: Convert a data.frame to a \code{treenetdf} -}} +\item \code{as_tree_data(data.frame)}: Convert a data.frame to a \code{treenetdf} +}} \examples{ links <- read.csv(header = TRUE, stringsAsFactors = FALSE, text = ' source,target,name diff --git a/man/sankey_network.Rd b/man/sankey_network.Rd index 57d19af..e7d29da 100644 --- a/man/sankey_network.Rd +++ b/man/sankey_network.Rd @@ -4,7 +4,7 @@ \alias{sankey_network} \title{Create an interactive sankey network plot in a htmlwidget} \usage{ -sankey_network(data, width = NULL, height = NULL, ..., viewer = "browser") +sankey_network(data, width = NULL, height = NULL, ..., viewer = "internal") } \arguments{ \item{data}{a network description in one of numerous forms (see details)}