|
a |
|
b/man/netOmics.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/netOmics-package.R |
|
|
3 |
\docType{package} |
|
|
4 |
\name{netOmics} |
|
|
5 |
\alias{netOmics-package} |
|
|
6 |
\alias{netOmics} |
|
|
7 |
\title{netOmics: network-based multi-omics integration and interpretation} |
|
|
8 |
\description{ |
|
|
9 |
netOmics is a multi-omics networks builder and explorer. |
|
|
10 |
It uses a combination of network inference algorithms and and knowledge-based |
|
|
11 |
graphs to build multi-layered networks. |
|
|
12 |
|
|
|
13 |
The package can be combined with |
|
|
14 |
\code{timeOmics} to incorporate time-course expression data and build |
|
|
15 |
sub-networks from multi-omics kinetic clusters. |
|
|
16 |
|
|
|
17 |
Finally, from the generated multi-omics networks, propagation analyses allow |
|
|
18 |
the identification of missing biological functions (1), |
|
|
19 |
multi-omics mechanisms (2) and molecules between kinetic clusters (3). |
|
|
20 |
This helps to resolve complex regulatory mechanisms. |
|
|
21 |
Here are the main functions. |
|
|
22 |
} |
|
|
23 |
\section{Network building}{ |
|
|
24 |
|
|
|
25 |
\describe{ |
|
|
26 |
\item{\code{get_grn}}{Based on expression matrix, this function build a gene |
|
|
27 |
gene regulatory network. Additionally, if clustering information is given, |
|
|
28 |
it builds cluster specific graph.} |
|
|
29 |
\item{\code{get_interaction_from_database}}{From a database (graph or data.frame |
|
|
30 |
with interactions between 2 molecules), this function build the induced |
|
|
31 |
graph based on a list of molecules . Alternatively, the function can |
|
|
32 |
build a graph with the first degree neighbors.} |
|
|
33 |
\item{\code{get_interaction_from_correlation}}{Compute correlation between two |
|
|
34 |
dataframe X and Y (or list of data.frame). |
|
|
35 |
An incidence graph is returned. A link between two features is produced |
|
|
36 |
if their correlation (absolute value) is above the threshold.} |
|
|
37 |
\item{\code{combine_layers}}{Combine 2 (or list of) graphs based on given |
|
|
38 |
intersections.} |
|
|
39 |
} |
|
|
40 |
} |
|
|
41 |
|
|
|
42 |
\section{Network exploration}{ |
|
|
43 |
|
|
|
44 |
\describe{ |
|
|
45 |
\item{\code{random_walk_restart}}{This function performs a propagation analysis |
|
|
46 |
by random walk with restart |
|
|
47 |
in a multi-layered network from specific seeds.} |
|
|
48 |
\item{\code{rwr_find_seeds_between_attributes}}{From rwr results, this function |
|
|
49 |
returns a subgraph if any vertex shares |
|
|
50 |
different attributes value. |
|
|
51 |
In biological context, this might be useful to identify vertex shared between |
|
|
52 |
clusters or omics types.} |
|
|
53 |
\item{\code{rwr_find_closest_type}}{From a rwr results, this function returns |
|
|
54 |
the closest nodes from a seed with |
|
|
55 |
a given attribute and value. |
|
|
56 |
In biological context, it might be useful to get the closest Gene Ontology |
|
|
57 |
annotation nodes from unannotated seeds.} |
|
|
58 |
} |
|
|
59 |
} |
|
|
60 |
|
|
|
61 |
\section{Visualisation}{ |
|
|
62 |
|
|
|
63 |
\describe{ |
|
|
64 |
\item{\code{summary_plot_rwr_attributes}}{#' Based on the results of |
|
|
65 |
\code{\link[netOmics]{rwr_find_seeds_between_attributes}} which identify the |
|
|
66 |
closest k neighbors from a seed, this function returns a barplot of the node |
|
|
67 |
types (layers) reached for each seed.} |
|
|
68 |
\item{\code{plot_rwr_subnetwork}}{Display the subgraph from a RWR results. |
|
|
69 |
This function colors adds a specific |
|
|
70 |
color to each node based on their 'type' attribute. |
|
|
71 |
It also adds a legend including the number of vertices/edges and the number |
|
|
72 |
of nodes of specific type. |
|
|
73 |
Additionally, the function can display any igraph object.} |
|
|
74 |
} |
|
|
75 |
} |
|
|
76 |
|
|
|
77 |
\seealso{ |
|
|
78 |
Useful links: |
|
|
79 |
\itemize{ |
|
|
80 |
\item \url{https://github.com/abodein/netOmics} |
|
|
81 |
\item Report bugs at \url{https://github.com/abodein/netOmics/issues} |
|
|
82 |
} |
|
|
83 |
|
|
|
84 |
} |
|
|
85 |
\author{ |
|
|
86 |
\strong{Maintainer}: Antoine Bodein \email{antoine.bodein.1@ulaval.ca} |
|
|
87 |
|
|
|
88 |
} |