File: plot_profile_region.Rd

package info (click to toggle)
r-bioc-mutationalpatterns 3.16.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 5,360 kB
  • sloc: sh: 8; makefile: 2
file content (58 lines) | stat: -rw-r--r-- 1,723 bytes parent folder | download | duplicates (3)
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_profile_region.R
\name{plot_profile_region}
\alias{plot_profile_region}
\title{Plot 96 trinucleotide profile per subgroup}
\usage{
plot_profile_region(
  mut_matrix,
  mode = c("relative_sample", "relative_sample_feature", "absolute"),
  colors = NULL,
  ymax = 0.2,
  condensed = FALSE
)
}
\arguments{
\item{mut_matrix}{Mutation matrix}

\item{mode}{'relative_sample', 'relative_sample_feature' or 'absolute'
When 'relative_sample', the number of variants will be shown
divided by the total number of variants in that sample.
When 'relative_sample_feature', the number of variants will be shown
divided by the total number of variants in that sample. and genomic region.}

\item{colors}{6 value color vector}

\item{ymax}{Y axis maximum value, default = 0.2}

\item{condensed}{More condensed plotting format. Default = FALSE.}
}
\value{
96 trinucleotide profile plot per region
}
\description{
Plot relative contribution of 96 trinucleotides per subgroup.
This can be genomic regions but could also be other subsets.
The function uses a matrix generated by 'lengthen_mut_matrix()'
as its input.
}
\examples{
## See the 'lengthen_mut_matrix()' example for how we obtained the
## mutation matrix information:
mut_mat_long <- readRDS(system.file("states/mut_mat_longregions.rds",
  package = "MutationalPatterns"
))

## Plot the 96-profile of three samples
plot_profile_region(mut_mat_long[, c(1, 4, 7)])
}
\seealso{
\code{\link{mut_matrix}}

Other genomic_regions: 
\code{\link{bin_mutation_density}()},
\code{\link{lengthen_mut_matrix}()},
\code{\link{plot_spectrum_region}()},
\code{\link{split_muts_region}()}
}
\concept{genomic_regions}