File: plot_indel_contexts.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 (70 lines) | stat: -rw-r--r-- 2,252 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
59
60
61
62
63
64
65
66
67
68
69
70
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_indel_contexts.R
\name{plot_indel_contexts}
\alias{plot_indel_contexts}
\title{Plot the indel contexts}
\usage{
plot_indel_contexts(
  counts,
  same_y = FALSE,
  extra_labels = FALSE,
  condensed = FALSE
)
}
\arguments{
\item{counts}{A tibble containing the number of indels per COSMIC context.}

\item{same_y}{A boolean describing whether the same y axis should be used for all samples.}

\item{extra_labels}{A boolean describing whether extra labels should be added.
These can clarify the plot, but will shift when different plot widths are used.
We recommend saving a plot with a width of 12, when using this argument.}

\item{condensed}{More condensed plotting format. Default = F.}
}
\value{
A ggplot figure.
}
\description{
Plot the indel contexts
}
\details{
Plots the number of indels  COSMIC context per sample.
It takes a tibble with counts as its input. This tibble can be generated by 'count_indel_contexts()'.
Each sample is plotted in a separate facet.
The same y axis can be used for all samples or a separate y axis can be used.
The facets at the top show the indel types. First the C and T deletions
Then the C and T insertions. Next are the multi base deletions and insertions.
Finally the deletions with microhomology (mh) are shown.
The x-axis at the bottom shows the number of repeat units.
For mh deletions the microhomology length is shown.
}
\examples{
## Get The indel counts
## See 'count_indel_contexts()' for more info on how to do this.
indel_counts <- readRDS(system.file("states/blood_indel_counts.rds",
  package = "MutationalPatterns"
))

## Plot contexts
plot_indel_contexts(indel_counts)

## Use the same y axis for all samples.
plot_indel_contexts(indel_counts, same_y = TRUE)

## Add extra labels to make plot clearer
plot_indel_contexts(indel_counts, extra_labels = TRUE)

## Create a more condensed plot
plot_indel_contexts(indel_counts, condensed = TRUE)
}
\seealso{
\code{\link{count_indel_contexts}}, \code{\link{plot_main_indel_contexts}}

Other Indels: 
\code{\link{count_indel_contexts}()},
\code{\link{get_indel_context}()},
\code{\link{plot_compare_indels}()},
\code{\link{plot_main_indel_contexts}()}
}
\concept{Indels}