Skip to content

Commit

Permalink
dontrun in example using bugsigdb
Browse files Browse the repository at this point in the history
  • Loading branch information
noriakis committed Apr 19, 2024
1 parent a3b9852 commit d8810b4
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 4 deletions.
6 changes: 5 additions & 1 deletion R/exportWCNetwork.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' exportWCNetwork
#'
#' @description Export wordcloud networks to Cytoscape.js
#' @details The function exports the wordcloud network provided the gene cluster network.
#' @details The function exports the wordcloud network by providing the gene cluster network.
#' Node size will be the number of genes in the cluster.
#' By default use cola layout, and see below for the parameters of the layout.
#' (https://github.com/cytoscape/cytoscape.js-cola)
Expand All @@ -22,6 +22,10 @@
#' @param wcScale scaling size for wordcloud
#' @importFrom RColorBrewer brewer.pal
#' @return export the Cytoscape.js network
#' @examples
#' g <- igraph::graph_from_edgelist(rbind(c("ME1","ME2")))
#' gl <- list("ME1"=c("PNKP","IRF3","MCM5"), "ME2"=c("IRF3","ERCC2","TP53"))
#' exportWCNetwork(g, gl)
#' @export
exportWCNetwork <- function(g, geneList, dir="network", colors=NULL,
sizeMin=50, sizeMax=200, wcScale=20,
Expand Down
5 changes: 4 additions & 1 deletion R/steps.R
Original file line number Diff line number Diff line change
Expand Up @@ -744,7 +744,10 @@ graph_cluster <- function(ret, func=igraph::cluster_leiden, factorize=TRUE) {
#' @param ec_file enzyme database file
#' @param up_tax_file UniProt taxonomy file
#' @export
#' @examples bugsigdb("Veillonella dispar") |> process_network_microbe()
#' @examples
#' \dontrun{
#' bugsigdb("Veillonella dispar") |> process_network_microbe()
#' }
#' @return biotext class object
#'
process_network_microbe <- function(ret, delete_zero_degree=TRUE,
Expand Down
7 changes: 6 additions & 1 deletion man/exportWCNetwork.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion man/process_network_microbe.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d8810b4

Please sign in to comment.