From b36d260d77cb42ace39c3d406e2f38faf31e0e90 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 9 Mar 2026 09:22:41 +0000 Subject: [PATCH] docs: AI-generated doc upgrade for `previewNetworkInBrowser` Auto-generated by weekly doc workflow. Target: R/exportNetworkToHTML.R::previewNetworkInBrowser Date: 2026-03-09T09:22:41Z --- R/exportNetworkToHTML.R | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/R/exportNetworkToHTML.R b/R/exportNetworkToHTML.R index c333cc4..95e2e4f 100644 --- a/R/exportNetworkToHTML.R +++ b/R/exportNetworkToHTML.R @@ -1,3 +1,4 @@ +```r #' Export network data with Cytoscape visualization #' #' Convenience function that takes nodes and edges data directly and creates @@ -29,7 +30,24 @@ exportNetworkToHTML <- function(nodes, edges, #' Preview network in browser #' -#' Creates a temporary HTML file and opens it in the default web browser +#' @description +#' Generates a temporary HTML file for the network visualization and opens it +#' in the default web browser for quick preview. +#' +#' @param nodes \code{data.frame} containing node information. +#' @param edges \code{data.frame} containing edge information. +#' @param displayLabelType \code{character} specifying the type of label to display on nodes. Default is \code{"id"}. +#' @param nodeFontSize \code{numeric} specifying the font size of node labels. Default is \code{12}. +#' +#' @return Invisibly returns the file path of the temporary HTML file. +#' +#' @examples +#' \dontrun{ +#' nodes <- data.frame(id = c("A", "B", "C")) +#' edges <- data.frame(source = c("A", "B"), target = c("B", "C")) +#' previewNetworkInBrowser(nodes, edges) +#' } +#' #' @export #' @importFrom utils browseURL #' @inheritParams exportNetworkToHTML @@ -53,4 +71,5 @@ previewNetworkInBrowser <- function(nodes, edges, } invisible(temp_file) -} \ No newline at end of file +} +``` \ No newline at end of file