Roxygen

NAMESPACE

@@ -8,6 +8,7 @@ export(DependencyReporter)
 export(FunctionReporter)
 export(InheritanceReporter)
 export(SummaryReporter)
+export(igraphAvailableLayouts)
 import(data.table)
 importFrom(DT,datatable)
 importFrom(DT,formatRound)

R/AbstractGraphReporter.R

@@ -19,7 +19,8 @@
 #'    \item{\code{network_measures}}{Returns a table of network measures, one row per node}
 #'    \item{\code{graph_viz}}{Returns the graph visualization object}
 #'    \item{\code{layout_type}}{If no value given, the current layout type for the graph visualization is returned.
-#'        If a valid layout type is given, this function will update the layout_type field.}
+#'        If a valid layout type is given, this function will update the layout_type field.
+#'        See \code{\link{igraphAvailableLayouts}} for valid options.}
 #' }
 #' @importFrom data.table data.table copy uniqueN
 #' @importFrom R6 R6Class
@@ -452,7 +453,15 @@ AbstractGraphReporter <- R6::R6Class(
     )
 )
 
-
+#' @title Available Graph Layout Functions from igraph
+#' @name igraphAvailableLayouts
+#' @description Returns available \link[igraph:layout_]{\code{igraph} layout function}
+#' names. These names can be passed to
+#' \code{\link[visNetwork:visIgraphLayout]{visNetwork::visIgraphLayout}} or set
+#' as the \code{layout_type} for any reporters that inherit from
+#' \code{\link{AbstractGraphReporter}}.
+#' @return a character vector of igraph layout function names
+#' @export
 igraphAvailableLayouts <- function() {
     return(grep("^layout_\\S", getNamespaceExports("igraph"), value = TRUE))
 }