diff --git a/R/as_force_data.R b/R/as_force_data.R index 3315eba..5d5f674 100644 --- a/R/as_force_data.R +++ b/R/as_force_data.R @@ -8,6 +8,7 @@ #' The `force_network` function uses a 'native' data format that consists of a... #' #' @md +#' #' @export as_force_data <- function(.data, ...) { @@ -15,7 +16,9 @@ as_force_data <- function(.data, ...) { } -#' @describeIn as_force_data +#' @describeIn as_force_data Convert data found at a URL to an appropriate +#' network data list +#' #' @export as_force_data.character <- function(.data, ...) { @@ -27,7 +30,9 @@ as_force_data.character <- function(.data, ...) { } -#' @describeIn as_force_data +#' @describeIn as_force_data Convert a data frame containing links data to an +#' appropriate network data list +#' #' @export as_force_data.data.frame <- @@ -42,7 +47,9 @@ as_force_data.data.frame <- } -#' @describeIn as_force_data +#' @describeIn as_force_data Convert an igraph object to an appropriate network +#' data list +#' #' @export as_force_data.igraph <- @@ -70,7 +77,9 @@ as_force_data.igraph <- } -#' @describeIn as_force_data +#' @describeIn as_force_data Convert a hclust object to an appropriate network +#' data list +#' #' @export as_force_data.hclust <- @@ -103,7 +112,9 @@ as_force_data.hclust <- } -#' @describeIn as_force_data +#' @describeIn as_force_data Convert a dendrogram object to an appropriate network +#' data list +#' #' @export as_force_data.dendrogram <- @@ -115,7 +126,9 @@ as_force_data.dendrogram <- } -#' @describeIn as_force_data +#' @describeIn as_force_data Convert a list object containg a links and a nodes +#' data frame to an appropriate network data list +#' #' @export as_force_data.list <- diff --git a/man/as_force_data.Rd b/man/as_force_data.Rd index f47943c..9bb8d86 100644 --- a/man/as_force_data.Rd +++ b/man/as_force_data.Rd @@ -2,9 +2,27 @@ % Please edit documentation in R/as_force_data.R \name{as_force_data} \alias{as_force_data} +\alias{as_force_data.character} +\alias{as_force_data.data.frame} +\alias{as_force_data.igraph} +\alias{as_force_data.hclust} +\alias{as_force_data.dendrogram} +\alias{as_force_data.list} \title{Convert one of numerous data types to force_network's 'native' data format} \usage{ as_force_data(.data, ...) + +\method{as_force_data}{character}(.data, ...) + +\method{as_force_data}{data.frame}(.data, ...) + +\method{as_force_data}{igraph}(.data, ...) + +\method{as_force_data}{hclust}(.data, ...) + +\method{as_force_data}{dendrogram}(.data, ...) + +\method{as_force_data}{list}(.data, ...) } \arguments{ \item{.data}{a force network description in one of numerous forms (see @@ -15,3 +33,24 @@ details).} \description{ The \code{force_network} function uses a 'native' data format that consists of a... } +\section{Methods (by class)}{ +\itemize{ +\item \code{as_force_data(character)}: Convert data found at a URL to an appropriate +network data list + +\item \code{as_force_data(data.frame)}: Convert a data frame containing links data to an +appropriate network data list + +\item \code{as_force_data(igraph)}: Convert an igraph object to an appropriate network +data list + +\item \code{as_force_data(hclust)}: Convert a hclust object to an appropriate network +data list + +\item \code{as_force_data(dendrogram)}: Convert a dendrogram object to an appropriate network +data list + +\item \code{as_force_data(list)}: Convert a list object containg a links and a nodes +data frame to an appropriate network data list + +}}