Skip to content

docs: Weekly AI doc upgrade for previewNetworkInBrowser #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

docs: Weekly AI doc upgrade for previewNetworkInBrowser #82

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions R/exportNetworkToHTML.R
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```r
#' Export network data with Cytoscape visualization
#'
#' Convenience function that takes nodes and edges data directly and creates
Expand Down Expand Up @@ -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
Expand All @@ -53,4 +71,5 @@ previewNetworkInBrowser <- function(nodes, edges,
}

invisible(temp_file)
}
}
```