|
a |
|
b/man/enrichment_spiral_plots.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/EnrichmentSpiralize.R |
|
|
3 |
\name{enrichment_spiral_plots} |
|
|
4 |
\alias{enrichment_spiral_plots} |
|
|
5 |
\title{Create Spiral Plots with Legends Using 'spiralize' and 'ComplexHeatmap'} |
|
|
6 |
\usage{ |
|
|
7 |
enrichment_spiral_plots(results) |
|
|
8 |
} |
|
|
9 |
\arguments{ |
|
|
10 |
\item{results}{A data frame containing 'Pathway', 'Sample', 'Value', 'PathwayColor', and 'SampleColor' columns.} |
|
|
11 |
} |
|
|
12 |
\value{ |
|
|
13 |
No return value, called for side effects. This function generates spiral plots and adds legends based on sample and pathway information. |
|
|
14 |
} |
|
|
15 |
\description{ |
|
|
16 |
This function initializes a spiral plot, adds tracks for pathways and samples, |
|
|
17 |
and generates legends based on the sample and pathway information in the provided data frame. |
|
|
18 |
It uses 'spiralize' for the spiral plot and 'ComplexHeatmap' for handling legends. |
|
|
19 |
} |
|
|
20 |
\examples{ |
|
|
21 |
# Example: Creating enrichment spiral plots with legends |
|
|
22 |
|
|
|
23 |
# Define the results data frame |
|
|
24 |
results <- data.frame( |
|
|
25 |
Pathway = c("Pathway1", "Pathway1", "Pathway2", "Pathway2", "Pathway3"), |
|
|
26 |
Sample = c("Sample1", "Sample1", "Sample2", "Sample2", "Sample3"), |
|
|
27 |
Value = c(20, 30, 15, 35, 25), |
|
|
28 |
PathwayColor = c("red", "red", "blue", "blue", "orange"), |
|
|
29 |
SampleColor = c("green", "green", "purple", "purple", "cyan"), |
|
|
30 |
stringsAsFactors = FALSE |
|
|
31 |
) |
|
|
32 |
|
|
|
33 |
# Create the enrichment spiral plots with legends |
|
|
34 |
enrichment_spiral_plots(results) |
|
|
35 |
|
|
|
36 |
} |