File: dot-decoupler_network_format.Rd

package info (click to toggle)
r-bioc-decoupler 2.12.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 2,612 kB
  • sloc: makefile: 5
file content (38 lines) | stat: -rw-r--r-- 1,343 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils-decoupler-formats.R
\name{.decoupler_network_format}
\alias{.decoupler_network_format}
\alias{network_format}
\title{DecoupleR network format}
\arguments{
\item{network}{Tibble or dataframe with edges and it's associated metadata.}

\item{.source}{Column with source nodes.}

\item{.target}{Column with target nodes.}

\item{.mor}{Column with edge mode of regulation (i.e. mor).}

\item{.likelihood}{Deprecated argument. Now it will always be set to 1.}
}
\description{
A network passed to any \code{run_} method in the package must contain at
least two attributes: \code{.source} and \code{.target}. In addition,
the methods must map their corresponding metadata associated with their edges.
}
\details{
\itemize{
\item All the attributes to be mapped are prefixed by \code{.}
\item The idea of using this type of mapping is to provide flexibility to
different types of networks, be they regulatory, metabolic, or of any
other type. This way, you should only consider having your network or
networks in a long format and these can easily be manipulated by functions
within the \href{https://www.tidyverse.org/}{tidyverse ecosystem}.
}
}
\seealso{
Other decoupleR formats: 
\code{\link{.decoupler_mat_format}}
}
\concept{decoupleR formats}
\keyword{internal}