... | ... |
@@ -1,6 +1,6 @@ |
1 | 1 |
Package: Gviz |
2 | 2 |
Title: Plotting data and annotation information along genomic coordinates |
3 |
-Version: 1.42.0 |
|
3 |
+Version: 1.42.1 |
|
4 | 4 |
Authors@R: c(person("Florian", "Hahne", role="aut"), |
5 | 5 |
person("Steffen", "Durinck", role="aut"), |
6 | 6 |
person("Robert", "Ivanek", role=c("aut", "cre"), |
... | ... |
@@ -23,7 +23,7 @@ Description: Genomic data analyses requires integrated visualization |
23 | 23 |
your data. |
24 | 24 |
LazyLoad: yes |
25 | 25 |
Encoding: UTF-8 |
26 |
-RoxygenNote: 7.1.2 |
|
26 |
+RoxygenNote: 7.2.3.9001 |
|
27 | 27 |
Roxygen: list(markdown = TRUE) |
28 | 28 |
Depends: |
29 | 29 |
R (>= 4.2), |
... | ... |
@@ -27,12 +27,12 @@ setClassUnion("SequenceTrackOrNULL", c("SequenceTrack", "NULL")) |
27 | 27 |
#' |
28 | 28 |
#' \describe{ |
29 | 29 |
#' |
30 |
-#' \item{}{A \code{character} string: the path to a \code{BAM} file containing |
|
30 |
+#' \item{A \code{character} string:}{ the path to a \code{BAM} file containing |
|
31 | 31 |
#' the read alignments. To be precise, this will result in the instantiation of |
32 | 32 |
#' a \code{ReferenceAlignmentsTrack} object, but for the user this |
33 | 33 |
#' implementation detail should be of no concern.} |
34 | 34 |
#' |
35 |
-#' \item{}{A \code{GRanges} object: the genomic ranges of the individual reads |
|
35 |
+#' \item{A \code{GRanges} object:}{ the genomic ranges of the individual reads |
|
36 | 36 |
#' as well as the optional additional metadata columns \code{id}, \code{cigar}, |
37 | 37 |
#' \code{mapq}, \code{flag}, \code{isize}, \code{groupid}, \code{status}, |
38 | 38 |
#' \code{md} and \code{seqs} (see description of the individual function |
... | ... |
@@ -40,7 +40,7 @@ setClassUnion("SequenceTrackOrNULL", c("SequenceTrack", "NULL")) |
40 | 40 |
#' object without further arguments, e.g. \code{AlignmentsTrack(range=obj)} is |
41 | 41 |
#' equivalent to calling the coerce method \code{as(obj, "AlignmentsTrack")}.} |
42 | 42 |
#' |
43 |
-#' \item{}{An \code{\linkS4class{IRanges}} object: almost identical to the |
|
43 |
+#' \item{An \code{\linkS4class{IRanges}} object:}{ almost identical to the |
|
44 | 44 |
#' \code{GRanges} case, except that the chromosome and strand information as |
45 | 45 |
#' well as all additional metadata has to be provided in the separate |
46 | 46 |
#' \code{chromosome}, \code{strand}, \code{feature}, \code{group} or \code{id} |
... | ... |
@@ -49,7 +49,7 @@ setClassUnion("SequenceTrackOrNULL", c("SequenceTrack", "NULL")) |
49 | 49 |
#' explicitely the more or less reasonable default values \code{chromosome=NA} |
50 | 50 |
#' and \code{strand="*"} are used. } |
51 | 51 |
#' |
52 |
-#' \item{}{A \code{data.frame} object: the \code{data.frame} needs to contain |
|
52 |
+#' \item{A \code{data.frame} object:}{ the \code{data.frame} needs to contain |
|
53 | 53 |
#' at least the two mandatory columns \code{start} and \code{end} with the |
54 | 54 |
#' range coordinates. It may also contain a \code{chromosome} and a |
55 | 55 |
#' \code{strand} column with the chromosome and strand information for each |
... | ... |
@@ -17,64 +17,64 @@ NULL |
17 | 17 |
#' |
18 | 18 |
#' \describe{ |
19 | 19 |
#' |
20 |
-#' \item{}{\code{p}: simple xy-plot.} |
|
20 |
+#' \item{\code{p}:}{ simple xy-plot.} |
|
21 | 21 |
#' |
22 |
-#' \item{}{\code{l}: lines plot. In the case of multiple samples this plotting |
|
22 |
+#' \item{\code{l}:}{ lines plot. In the case of multiple samples this plotting |
|
23 | 23 |
#' type is not overly usefull since the points in the data matrix are connected |
24 | 24 |
#' in column-wise order. Type \code{a} might be more appropriate in these |
25 | 25 |
#' situations.} |
26 | 26 |
#' |
27 |
-#' \item{}{\code{b}: combination of xy-plot and lines plot.} |
|
27 |
+#' \item{\code{b}:}{ combination of xy-plot and lines plot.} |
|
28 | 28 |
#' |
29 |
-#' \item{}{\code{a}: lines plot of the column-wise average values.} |
|
29 |
+#' \item{\code{a}:}{ lines plot of the column-wise average values.} |
|
30 | 30 |
#' |
31 |
-#' \item{}{\code{s}: sort and connect data points along the x-axis} |
|
31 |
+#' \item{\code{s}:}{ sort and connect data points along the x-axis} |
|
32 | 32 |
#' |
33 |
-#' \item{}{\code{S}: sort and connect data points along the y-axis} |
|
33 |
+#' \item{\code{S}:}{ sort and connect data points along the y-axis} |
|
34 | 34 |
#' |
35 |
-#' \item{}{\code{g}: add grid lines. To ensure a consitant look and feel across |
|
35 |
+#' \item{\code{g}:}{ add grid lines. To ensure a consitant look and feel across |
|
36 | 36 |
#' multiple tracks, grid lines should preferentially be added by using the |
37 | 37 |
#' \code{grid} display parameter.} |
38 | 38 |
#' |
39 |
-#' \item{}{\code{r}: add a regression line to the plot.} |
|
39 |
+#' \item{\code{r}:}{ add a regression line to the plot.} |
|
40 | 40 |
#' |
41 |
-#' \item{}{\code{h}: histogram-like vertical lines centered in the middle of |
|
41 |
+#' \item{\code{h}:}{ histogram-like vertical lines centered in the middle of |
|
42 | 42 |
#' the coordinate ranges.} |
43 | 43 |
#' |
44 |
-#' \item{}{\code{smooth}: add a loess fit to the plot. The following display |
|
44 |
+#' \item{\code{smooth}:}{ add a loess fit to the plot. The following display |
|
45 | 45 |
#' parameters can be used to control the loess calculation: \code{span, degree, |
46 | 46 |
#' family, evaluation}. See \code{\link{panel.loess}} for details.} |
47 | 47 |
#' |
48 |
-#' \item{}{\code{histogram}: plot data as a histogram, where the width of the |
|
48 |
+#' \item{\code{histogram}:}{ plot data as a histogram, where the width of the |
|
49 | 49 |
#' histogram bars reflects the width of the genomic ranges in the \code{range} |
50 | 50 |
#' slot.} |
51 | 51 |
#' |
52 |
-#' \item{}{\code{mountain}: plot a smoothed version of the data relative to a |
|
52 |
+#' \item{\code{mountain}:}{ plot a smoothed version of the data relative to a |
|
53 | 53 |
#' baseline, as defined by the \code{baseline} display parameter. The following |
54 | 54 |
#' display parameters can be used to control the smoothing: \code{span, degree, |
55 | 55 |
#' family, evaluation}. See \code{\link{panel.loess}} for details. The layout |
56 | 56 |
#' of the plot can be further customized via the following display parameters: |
57 | 57 |
#' \code{col.mountain, lwd.mountain, lty.mountain, fill.mountain}.} |
58 | 58 |
#' |
59 |
-#' \item{}{\code{polygon}: plot data as a polygon (similar to |
|
59 |
+#' \item{\code{polygon}:}{ plot data as a polygon (similar to |
|
60 | 60 |
#' \code{mountain}-type but without smoothing). Data are plotted relative to a |
61 | 61 |
#' baseline, as defined by the \code{baseline} display parameter. The layout of |
62 | 62 |
#' the plot can be further customized via the following display parameters: |
63 | 63 |
#' \code{col.mountain, lwd.mountain, lty.mountain, fill.mountain}.} |
64 | 64 |
#' |
65 |
-#' \item{}{\code{boxplot}: plot the data as box-and-whisker plots. The layout |
|
65 |
+#' \item{\code{boxplot}:}{ plot the data as box-and-whisker plots. The layout |
|
66 | 66 |
#' of the plot can be further customized via the following display parameters: |
67 | 67 |
#' \code{box.ratio, box.width, varwidt, notch, notch.frac, levels.fos, stats, |
68 | 68 |
#' coef, do.out}. See \code{\link{panel.bwplot}} for details.} |
69 | 69 |
#' |
70 |
-#' \item{}{\code{gradient}: collapse the data across samples and plot this |
|
70 |
+#' \item{\code{gradient}:}{ collapse the data across samples and plot this |
|
71 | 71 |
#' average value as a color-coded gradient. Essenitally this is similar to the |
72 | 72 |
#' heatmap-type plot of a single sample. The layout of the plot can be further |
73 | 73 |
#' customized via the display parameters \code{ncolor} and \code{gradient} |
74 | 74 |
#' which control the number of gradient colors as well as the gradient base |
75 | 75 |
#' colors, respectively.} |
76 | 76 |
#' |
77 |
-#' \item{}{\code{heatmap}: plot the color-coded values for all samples in the |
|
77 |
+#' \item{\code{heatmap}:}{ plot the color-coded values for all samples in the |
|
78 | 78 |
#' form of a heatmap. The data for individual samples can be visually separated |
79 | 79 |
#' by setting the \code{separator} display parameter. It's value is taken as |
80 | 80 |
#' the amount of spacing in pixels in between two heatmap rows. The layout of |
... | ... |
@@ -82,7 +82,7 @@ NULL |
82 | 82 |
#' and \code{gradient} which control the number of gradient colors as well as |
83 | 83 |
#' the gradient base colors, respectively.} |
84 | 84 |
#' |
85 |
-#' \item{}{\code{horizon}: plot continuous data by cutting the y range into |
|
85 |
+#' \item{\code{horizon}:}{ plot continuous data by cutting the y range into |
|
86 | 86 |
#' segments and overplotting them with color representing the magnitude and |
87 | 87 |
#' direction of deviation. This is particularly useful when comparing multiple |
88 | 88 |
#' samples, in which case the horizon strips are stacked. See |
... | ... |
@@ -937,7 +937,7 @@ setMethod("drawGD", signature("DataTrack"), function(GdObject, minBase, maxBase, |
937 | 937 |
vals <- values(GdObject) |
938 | 938 |
groups <- .dpOrDefault(GdObject, "groups") |
939 | 939 |
if (!is.null(groups) && length(groups) != nrow(vals)) { |
940 |
- stop("'groups' must be a vector of similar length as the number of rows in the data matrix (", nrow(vals), ")") |
|
940 |
+ stop("'groups' must be a vector of the same length as the number of rows in the data matrix (", nrow(vals), ")") |
|
941 | 941 |
} |
942 | 942 |
if (!is.null(groups) && !is.factor(groups)) { |
943 | 943 |
groups <- factor(groups) |
... | ... |
@@ -59,7 +59,7 @@ NULL |
59 | 59 |
#' |
60 | 60 |
#' \describe{ |
61 | 61 |
#' |
62 |
-#' \item{}{A \code{TxDb} object: all the necessary gene model information |
|
62 |
+#' \item{A \code{TxDb} object:}{ all the necessary gene model information |
|
63 | 63 |
#' including exon locations, transcript groupings and associated gene ids are |
64 | 64 |
#' contained in \code{TxDb} objects, and the coercion between the two is almost |
65 | 65 |
#' completely automated. If desired, the data to be fetched from the |
... | ... |
@@ -70,7 +70,7 @@ NULL |
70 | 70 |
#' coding region information that is part of the original \code{TxDb} object is |
71 | 71 |
#' retained in the \code{GeneRegionTrack}.} |
72 | 72 |
#' |
73 |
-#' \item{}{A \code{GRanges} object: the genomic ranges for the |
|
73 |
+#' \item{A \code{GRanges} object:}{ the genomic ranges for the |
|
74 | 74 |
#' \code{GeneRegion} track as well as the optional additional metadata columns |
75 | 75 |
#' \code{feature}, \code{transcript}, \code{gene}, \code{exon} and |
76 | 76 |
#' \code{symbol} (see description of the individual function parameters below |
... | ... |
@@ -78,7 +78,7 @@ NULL |
78 | 78 |
#' further arguments, e.g. \code{GeneRegionTrack(range=obj)} is equivalent to |
79 | 79 |
#' calling the coerce method \code{as(obj, "GeneRegionTrack")}.} |
80 | 80 |
#' |
81 |
-#' \item{}{A \code{GRangesList} object: this is very similar to the previous |
|
81 |
+#' \item{A \code{GRangesList} object:}{ this is very similar to the previous |
|
82 | 82 |
#' case, except that the grouping information that is part of the list |
83 | 83 |
#' structure is preserved in the \code{GeneRegionTrack}. I.e., all the elements |
84 | 84 |
#' within one list item receive the same group id. For consistancy, there is |
... | ... |
@@ -88,7 +88,7 @@ NULL |
88 | 88 |
#' data slots, the object will not be particularly useful, because all the |
89 | 89 |
#' identifiers will be set to a common default value.} |
90 | 90 |
#' |
91 |
-#' \item{}{An \code{\linkS4class{IRanges}} object: almost identical to the |
|
91 |
+#' \item{An \code{\linkS4class{IRanges}} object:}{ almost identical to the |
|
92 | 92 |
#' \code{GRanges} case, except that the chromosome and strand information as |
93 | 93 |
#' well as all additional data has to be provided in the separate |
94 | 94 |
#' \code{chromosome}, \code{strand}, \code{feature}, \code{transcript}, |
... | ... |
@@ -99,7 +99,7 @@ NULL |
99 | 99 |
#' providing information about the gene-to-transcript relationship or the |
100 | 100 |
#' human-readble symbols renders a lot of the class' functionality useles.} |
101 | 101 |
#' |
102 |
-#' \item{}{A \code{data.frame} object: the \code{data.frame} needs to contain |
|
102 |
+#' \item{A \code{data.frame} object:}{ the \code{data.frame} needs to contain |
|
103 | 103 |
#' at least the two mandatory columns \code{start} and \code{end} with the |
104 | 104 |
#' range coordinates. It may also contain a \code{chromosome} and a |
105 | 105 |
#' \code{strand} column with the chromosome and strand information for each |
... | ... |
@@ -109,7 +109,7 @@ NULL |
109 | 109 |
#' \code{symbol} data can be provided as columns in the \code{data.frame}. The |
110 | 110 |
#' above comments about potential default values also apply here.} |
111 | 111 |
#' |
112 |
-#' \item{}{A \code{character} scalar: in this case the value of the |
|
112 |
+#' \item{A \code{character} scalar:}{ in this case the value of the |
|
113 | 113 |
#' \code{range} argument is considered to be a file path to an annotation file |
114 | 114 |
#' on disk. A range of file types are supported by the \code{Gviz} package as |
115 | 115 |
#' identified by the file extension. See the \code{importFunction} |
... | ... |
@@ -23,16 +23,16 @@ NULL |
23 | 23 |
#' |
24 | 24 |
#' \describe{ |
25 | 25 |
#' |
26 |
-#' \item{}{An object of class \code{\linkS4class{DNAStringSet}}. The individual |
|
26 |
+#' \item{An object of class \code{\linkS4class{DNAStringSet}}.}{ The individual |
|
27 | 27 |
#' \code{\linkS4class{DNAString}}s are considered to be the different |
28 | 28 |
#' chromosome sequences.} |
29 | 29 |
#' |
30 |
-#' \item{}{An object of class \code{\linkS4class{BSgenome}}. The \code{Gviz} |
|
30 |
+#' \item{An object of class \code{\linkS4class{BSgenome}}.}{ The \code{Gviz} |
|
31 | 31 |
#' package tries to follow the \code{BSgenome} philosophy in that the |
32 | 32 |
#' respective chromosome sequences are only realized once they are first |
33 | 33 |
#' accessed.} |
34 | 34 |
#' |
35 |
-#' \item{}{A \code{character} scalar: in this case the value of the |
|
35 |
+#' \item{A \code{character} scalar:}{ in this case the value of the |
|
36 | 36 |
#' \code{sequence} argument is considered to be a file path to an annotation |
37 | 37 |
#' file on disk. A range of file types are supported by the \code{Gviz} package |
38 | 38 |
#' as identified by the file extension. See the \code{importFunction} |
... | ... |
@@ -315,7 +315,7 @@ UcscTrack <- function(track, table = NULL, |
315 | 315 |
} |
316 | 316 |
args <- lapply(list(...), function(x) { |
317 | 317 |
if (is.character(x) && length(x) == 1) { |
318 |
- if (!x %in% colnames(tableDat)) x else tableDat[, x] |
|
318 |
+ if (!x %in% colnames(tableDat)) x else unlist(tableDat[, x]) |
|
319 | 319 |
} else { |
320 | 320 |
x |
321 | 321 |
} |
... | ... |
@@ -89,83 +89,83 @@ |
89 | 89 |
#' |
90 | 90 |
#' \describe{ |
91 | 91 |
#' |
92 |
-#' \item{GenomeAxisTrack}{: |
|
92 |
+#' \item{GenomeAxisTrack:}{ |
|
93 | 93 |
#' |
94 | 94 |
#' \describe{ |
95 | 95 |
#' |
96 |
-#' \item{}{\code{add35=FALSE}: Logical scalar. Add 3' to 5' direction |
|
96 |
+#' \item{\code{add35=FALSE}:}{ Logical scalar. Add 3' to 5' direction |
|
97 | 97 |
#' indicators.} |
98 | 98 |
#' |
99 |
-#' \item{}{\code{add53=FALSE}: Logical scalar. Add 5' to 3' direction |
|
99 |
+#' \item{\code{add53=FALSE}:}{ Logical scalar. Add 5' to 3' direction |
|
100 | 100 |
#' indicators.} |
101 | 101 |
#' |
102 |
-#' \item{}{\code{background.title="transparent"}: Character scalar. The |
|
102 |
+#' \item{\code{background.title="transparent"}:}{ Character scalar. The |
|
103 | 103 |
#' background color for the title panel. Defaults to omit the background.} |
104 | 104 |
#' |
105 |
-#' \item{}{\code{cex.id=0.7}: Numeric scalar. The text size for the optional |
|
105 |
+#' \item{\code{cex.id=0.7}:}{ Numeric scalar. The text size for the optional |
|
106 | 106 |
#' range annotation.} |
107 | 107 |
#' |
108 |
-#' \item{}{\code{cex=0.8}: Numeric scalar. The overall font expansion factor |
|
108 |
+#' \item{\code{cex=0.8}:}{ Numeric scalar. The overall font expansion factor |
|
109 | 109 |
#' for the axis annotation text.} |
110 | 110 |
#' |
111 |
-#' \item{}{\code{col.border.title="transparent"}: Integer or character scalar. |
|
111 |
+#' \item{\code{col.border.title="transparent"}:}{ Integer or character scalar. |
|
112 | 112 |
#' The border color for the title panels.} |
113 | 113 |
#' |
114 |
-#' \item{}{\code{lwd.border.title=1}: Integer scalar. The border width for the |
|
114 |
+#' \item{\code{lwd.border.title=1}:}{ Integer scalar. The border width for the |
|
115 | 115 |
#' title panels.} |
116 | 116 |
#' |
117 |
-#' \item{}{\code{col.id="white"}: Character scalar. The text color for the |
|
117 |
+#' \item{\code{col.id="white"}:}{ Character scalar. The text color for the |
|
118 | 118 |
#' optional range annotation.} |
119 | 119 |
#' |
120 |
-#' \item{}{\code{col.range="cornsilk4"}: Character scalar. The border color for |
|
120 |
+#' \item{\code{col.range="cornsilk4"}:}{ Character scalar. The border color for |
|
121 | 121 |
#' highlighted regions on the axis.} |
122 | 122 |
#' |
123 |
-#' \item{}{\code{distFromAxis=1}: Numeric scalar. Control the distance of the |
|
123 |
+#' \item{\code{distFromAxis=1}:}{ Numeric scalar. Control the distance of the |
|
124 | 124 |
#' axis annotation from the tick marks.} |
125 | 125 |
#' |
126 |
-#' \item{}{\code{exponent=NULL}: Numeric scalar. The exponent for the axis |
|
126 |
+#' \item{\code{exponent=NULL}:}{ Numeric scalar. The exponent for the axis |
|
127 | 127 |
#' coordinates, e.g., 3 means mb, 6 means gb, etc. The default is to |
128 | 128 |
#' automatically determine the optimal exponent.} |
129 | 129 |
#' |
130 |
-#' \item{}{\code{fill.range="cornsilk3"}: Character scalar. The fill color for |
|
130 |
+#' \item{\code{fill.range="cornsilk3"}:}{ Character scalar. The fill color for |
|
131 | 131 |
#' highlighted regions on the axis.} |
132 | 132 |
#' |
133 |
-#' \item{}{\code{fontcolor="#808080"}: Character scalar. The font color for the |
|
133 |
+#' \item{\code{fontcolor="#808080"}:}{ Character scalar. The font color for the |
|
134 | 134 |
#' axis annotation text.} |
135 | 135 |
#' |
136 |
-#' \item{}{\code{fontsize=10}: Numeric scalar. Font size for the axis |
|
136 |
+#' \item{\code{fontsize=10}:}{ Numeric scalar. Font size for the axis |
|
137 | 137 |
#' annotation text in points.} |
138 | 138 |
#' |
139 |
-#' \item{}{\code{labelPos="alternating"}: Character vector, one in |
|
139 |
+#' \item{\code{labelPos="alternating"}:}{ Character vector, one in |
|
140 | 140 |
#' "alternating", "revAlternating", "above" or "below". The vertical |
141 | 141 |
#' positioning of the axis labels. If \code{scale} is not \code{NULL}, the |
142 | 142 |
#' possible values are "above", "below" and "beside".} |
143 | 143 |
#' |
144 |
-#' \item{}{\code{littleTicks=FALSE}: Logical scalar. Add more fine-grained tick |
|
144 |
+#' \item{\code{littleTicks=FALSE}:}{ Logical scalar. Add more fine-grained tick |
|
145 | 145 |
#' marks.} |
146 | 146 |
#' |
147 |
-#' \item{}{\code{lwd=2}: Numeric scalar. The line width for the axis |
|
147 |
+#' \item{\code{lwd=2}:}{ Numeric scalar. The line width for the axis |
|
148 | 148 |
#' elementes.} |
149 | 149 |
#' |
150 |
-#' \item{}{\code{scale=NULL}: Numeric scalar. If not \code{NULL} a small scale |
|
150 |
+#' \item{\code{scale=NULL}:}{ Numeric scalar. If not \code{NULL} a small scale |
|
151 | 151 |
#' is drawn instead of the full axis, if the value is between 0 and 1 it is |
152 | 152 |
#' interpreted as a fraction of the current plotting region, otherwise as an |
153 | 153 |
#' absolute length value in genomic coordinates.} |
154 | 154 |
#' |
155 |
-#' \item{}{\code{showId=FALSE}: Logical scalar. Show the optional range |
|
155 |
+#' \item{\code{showId=FALSE}:}{ Logical scalar. Show the optional range |
|
156 | 156 |
#' highlighting annotation.} |
157 | 157 |
#' |
158 |
-#' \item{}{\code{showTitle=FALSE}: Logical scalar. Plot a title panel. Defaults |
|
158 |
+#' \item{\code{showTitle=FALSE}:}{ Logical scalar. Plot a title panel. Defaults |
|
159 | 159 |
#' to omit the title panel.} |
160 | 160 |
#' |
161 |
-#' \item{}{\code{ticksAt=NULL}: Numeric scalar. The exact x-position for |
|
161 |
+#' \item{\code{ticksAt=NULL}:}{ Numeric scalar. The exact x-position for |
|
162 | 162 |
#' tickmarks (in base-pairs).} |
163 | 163 |
#' |
164 |
-#' \item{}{\code{size=NULL}: Numeric scalar. The relative size of the track. |
|
164 |
+#' \item{\code{size=NULL}:}{ Numeric scalar. The relative size of the track. |
|
165 | 165 |
#' Can be overridden in the \code{\link{plotTracks}} function. Defaults to the |
166 | 166 |
#' ideal size based on the other track settings.} |
167 | 167 |
#' |
168 |
-#' \item{}{\code{col="darkgray"}: Character scalar. The color for the axis |
|
168 |
+#' \item{\code{col="darkgray"}:}{ Character scalar. The color for the axis |
|
169 | 169 |
#' lines and tickmarks.} |
170 | 170 |
#' |
171 | 171 |
#' } |
... | ... |
@@ -174,135 +174,135 @@ |
174 | 174 |
#' |
175 | 175 |
#' \describe{ |
176 | 176 |
#' |
177 |
-#' \item{}{\code{alpha=1}: Numeric scalar. The transparency for all track |
|
177 |
+#' \item{\code{alpha=1}:}{ Numeric scalar. The transparency for all track |
|
178 | 178 |
#' items.} |
179 | 179 |
#' |
180 |
-#' \item{}{\code{alpha.title=NULL}: Numeric scalar. The transparency for the |
|
180 |
+#' \item{\code{alpha.title=NULL}:}{ Numeric scalar. The transparency for the |
|
181 | 181 |
#' title panel.} |
182 | 182 |
#' |
183 |
-#' \item{}{\code{background.panel="transparent"}: Integer or character scalar. |
|
183 |
+#' \item{\code{background.panel="transparent"}:}{ Integer or character scalar. |
|
184 | 184 |
#' The background color of the content panel.} |
185 | 185 |
#' |
186 |
-#' \item{}{\code{background.legend="transparent"}: Integer or character scalar. |
|
186 |
+#' \item{\code{background.legend="transparent"}:}{ Integer or character scalar. |
|
187 | 187 |
#' The background color for the legend.} |
188 | 188 |
#' |
189 |
-#' \item{}{\code{cex.axis=NULL}: Numeric scalar. The expansion factor for the |
|
189 |
+#' \item{\code{cex.axis=NULL}:}{ Numeric scalar. The expansion factor for the |
|
190 | 190 |
#' axis annotation. Defaults to \code{NULL}, in which case it is automatically |
191 | 191 |
#' determined based on the available space.} |
192 | 192 |
#' |
193 |
-#' \item{}{\code{cex.title=NULL}: Numeric scalar. The expansion factor for the |
|
193 |
+#' \item{\code{cex.title=NULL}:}{ Numeric scalar. The expansion factor for the |
|
194 | 194 |
#' title panel. This effects the fontsize of both the title and the axis, if |
195 | 195 |
#' any. Defaults to \code{NULL}, which means that the text size is |
196 | 196 |
#' automatically adjusted to the available space.} |
197 | 197 |
#' |
198 |
-#' \item{}{\code{col.axis="white"}: Integer or character scalar. The font and |
|
198 |
+#' \item{\code{col.axis="white"}:}{ Integer or character scalar. The font and |
|
199 | 199 |
#' line color for the y axis, if any.} |
200 | 200 |
#' |
201 |
-#' \item{}{\code{col.frame="lightgray"}: Integer or character scalar. The line |
|
201 |
+#' \item{\code{col.frame="lightgray"}:}{ Integer or character scalar. The line |
|
202 | 202 |
#' color used for the panel frame, if \code{frame==TRUE}} |
203 | 203 |
#' |
204 |
-#' \item{}{\code{col.grid="#808080"}: Integer or character scalar. Default |
|
204 |
+#' \item{\code{col.grid="#808080"}:}{ Integer or character scalar. Default |
|
205 | 205 |
#' line color for grid lines, both when \code{type=="g"} in |
206 | 206 |
#' \code{\linkS4class{DataTrack}}s and when display parameter \code{grid==TRUE}.} |
207 | 207 |
#' |
208 |
-#' \item{}{\code{col.line=NULL}: Integer or character scalar. Default colors |
|
208 |
+#' \item{\code{col.line=NULL}:}{ Integer or character scalar. Default colors |
|
209 | 209 |
#' for plot lines. Usually the same as the global \code{col} parameter.} |
210 | 210 |
#' |
211 |
-#' \item{}{\code{col.symbol=NULL}: Integer or character scalar. Default colors |
|
211 |
+#' \item{\code{col.symbol=NULL}:}{ Integer or character scalar. Default colors |
|
212 | 212 |
#' for plot symbols. Usually the same as the global \code{col} parameter.} |
213 | 213 |
#' |
214 |
-#' \item{}{\code{col.title="white"}: Integer or character scalar. The border |
|
214 |
+#' \item{\code{col.title="white"}:}{ Integer or character scalar. The border |
|
215 | 215 |
#' color for the title panels} |
216 | 216 |
#' |
217 |
-#' \item{}{\code{collapse=TRUE}: Boolean controlling whether to collapse the |
|
217 |
+#' \item{\code{collapse=TRUE}:}{ Boolean controlling whether to collapse the |
|
218 | 218 |
#' content of the track to accomodate the minimum current device resolution. |
219 | 219 |
#' See \code{\link{collapsing}} for details.} |
220 | 220 |
#' |
221 |
-#' \item{}{\code{fill="lightgray"}: Integer or character scalar. Default fill |
|
221 |
+#' \item{\code{fill="lightgray"}:}{ Integer or character scalar. Default fill |
|
222 | 222 |
#' color setting for all plotting elements, unless there is a more specific |
223 | 223 |
#' control defined elsewhere.} |
224 | 224 |
#' |
225 |
-#' \item{}{\code{fontface.title=2}: Integer or character scalar. The font face |
|
225 |
+#' \item{\code{fontface.title=2}:}{ Integer or character scalar. The font face |
|
226 | 226 |
#' for the title panels.} |
227 | 227 |
#' |
228 |
-#' \item{}{\code{fontface=1}: Integer or character scalar. The font face for |
|
228 |
+#' \item{\code{fontface=1}:}{ Integer or character scalar. The font face for |
|
229 | 229 |
#' all text, unless a more specific definition exists.} |
230 | 230 |
#' |
231 |
-#' \item{}{\code{fontfamily.title="sans"}: Integer or character scalar. The |
|
231 |
+#' \item{\code{fontfamily.title="sans"}:}{ Integer or character scalar. The |
|
232 | 232 |
#' font family for the title panels.} |
233 | 233 |
#' |
234 |
-#' \item{}{\code{fontfamily="sans"}: Integer or character scalar. The font |
|
234 |
+#' \item{\code{fontfamily="sans"}:}{ Integer or character scalar. The font |
|
235 | 235 |
#' family for all text, unless a more specific definition exists.} |
236 | 236 |
#' |
237 |
-#' \item{}{\code{frame=FALSE}: Boolean. Draw a frame around the track when |
|
237 |
+#' \item{\code{frame=FALSE}:}{ Boolean. Draw a frame around the track when |
|
238 | 238 |
#' plotting.} |
239 | 239 |
#' |
240 |
-#' \item{}{\code{grid=FALSE}: Boolean, switching on/off the plotting of a |
|
240 |
+#' \item{\code{grid=FALSE}:}{ Boolean, switching on/off the plotting of a |
|
241 | 241 |
#' grid.} |
242 | 242 |
#' |
243 |
-#' \item{}{\code{h=-1}: Integer scalar. Parameter controlling the number of |
|
243 |
+#' \item{\code{h=-1}:}{ Integer scalar. Parameter controlling the number of |
|
244 | 244 |
#' horizontal grid lines, see \code{\link{panel.grid}} for details.} |
245 | 245 |
#' |
246 |
-#' \item{}{\code{lineheight=1}: Numeric scalar. The font line height for all |
|
246 |
+#' \item{\code{lineheight=1}:}{ Numeric scalar. The font line height for all |
|
247 | 247 |
#' text, unless a more specific definition exists.} |
248 | 248 |
#' |
249 |
-#' \item{}{\code{lty.grid="solid"}: Integer or character scalar. Default line |
|
249 |
+#' \item{\code{lty.grid="solid"}:}{ Integer or character scalar. Default line |
|
250 | 250 |
#' type for grid lines, both when \code{type=="g"} in \code{\linkS4class{DataTrack}}s |
251 | 251 |
#' and when display parameter \code{grid==TRUE}.} |
252 | 252 |
#' |
253 |
-#' \item{}{\code{lty="solid"}: Numeric scalar. Default line type setting for |
|
253 |
+#' \item{\code{lty="solid"}:}{ Numeric scalar. Default line type setting for |
|
254 | 254 |
#' all plotting elements, unless there is a more specific control defined |
255 | 255 |
#' elsewhere.} |
256 | 256 |
#' |
257 |
-#' \item{}{\code{lwd.title=1}: Integer scalar. The border width for the title |
|
257 |
+#' \item{\code{lwd.title=1}:}{ Integer scalar. The border width for the title |
|
258 | 258 |
#' panels} |
259 | 259 |
#' |
260 |
-#' \item{}{\code{lwd.grid=1}: Numeric scalar. Default line width for grid |
|
260 |
+#' \item{\code{lwd.grid=1}:}{ Numeric scalar. Default line width for grid |
|
261 | 261 |
#' lines, both when \code{type=="g"} in \code{\linkS4class{DataTrack}}s and when |
262 | 262 |
#' display parameter \code{grid==TRUE}.} |
263 | 263 |
#' |
264 |
-#' \item{}{\code{min.distance=1}: Numeric scalar. The minimum pixel distance |
|
264 |
+#' \item{\code{min.distance=1}:}{ Numeric scalar. The minimum pixel distance |
|
265 | 265 |
#' before collapsing range items, only if \code{collapse==TRUE}. See |
266 | 266 |
#' \code{\link{collapsing}} for details.} |
267 | 267 |
#' |
268 |
-#' \item{}{\code{min.height=3}: Numeric scalar. The minimum range height in |
|
268 |
+#' \item{\code{min.height=3}:}{ Numeric scalar. The minimum range height in |
|
269 | 269 |
#' pixels to display. All ranges are expanded to this size in order to avoid |
270 | 270 |
#' rendering issues. See \code{\link{collapsing}} for details.} |
271 | 271 |
#' |
272 |
-#' \item{}{\code{min.width=1}: Numeric scalar. The minimum range width in |
|
272 |
+#' \item{\code{min.width=1}:}{ Numeric scalar. The minimum range width in |
|
273 | 273 |
#' pixels to display. All ranges are expanded to this size in order to avoid |
274 | 274 |
#' rendering issues. See \code{\link{collapsing}} for details.} |
275 | 275 |
#' |
276 |
-#' \item{}{\code{reverseStrand=FALSE}: Logical scalar. Set up the plotting |
|
276 |
+#' \item{\code{reverseStrand=FALSE}:}{ Logical scalar. Set up the plotting |
|
277 | 277 |
#' coordinates in 3' -> 5' direction if \code{TRUE}. This will effectively |
278 | 278 |
#' mirror the plot on the vertical axis.} |
279 | 279 |
#' |
280 |
-#' \item{}{\code{rotation.title=90}: The rotation angle for the text in the |
|
280 |
+#' \item{\code{rotation.title=90}:}{ The rotation angle for the text in the |
|
281 | 281 |
#' title panel. Even though this can be adjusted, the automatic resizing of the |
282 | 282 |
#' title panel will currently not work, so use at own risk.} |
283 | 283 |
#' |
284 |
-#' \item{}{\code{rotation=0}: The rotation angle for all text unless a more |
|
284 |
+#' \item{\code{rotation=0}:}{ The rotation angle for all text unless a more |
|
285 | 285 |
#' specific definiton exists.} |
286 | 286 |
#' |
287 |
-#' \item{}{\code{showAxis=TRUE}: Boolean controlling whether to plot a y axis |
|
287 |
+#' \item{\code{showAxis=TRUE}:}{ Boolean controlling whether to plot a y axis |
|
288 | 288 |
#' (only applies to track types where axes are implemented).} |
289 | 289 |
#' |
290 |
-#' \item{}{\code{v=-1}: Integer scalar. Parameter controlling the number of |
|
290 |
+#' \item{\code{v=-1}:}{ Integer scalar. Parameter controlling the number of |
|
291 | 291 |
#' vertical grid lines, see \code{\link{panel.grid}} for details.} |
292 | 292 |
#' |
293 | 293 |
#' } |
294 | 294 |
#' |
295 | 295 |
#' } |
296 | 296 |
#' |
297 |
-#' \item{DataTrack}{: |
|
297 |
+#' \item{DataTrack:}{ |
|
298 | 298 |
#' |
299 | 299 |
#' \describe{ |
300 | 300 |
#' |
301 |
-#' \item{}{\code{aggregateGroups=FALSE}: Logical scalar. Aggregate the values |
|
301 |
+#' \item{\code{aggregateGroups=FALSE}:}{ Logical scalar. Aggregate the values |
|
302 | 302 |
#' within a sample group using the aggregation funnction specified in the |
303 | 303 |
#' \code{aggregation} parameter.} |
304 | 304 |
#' |
305 |
-#' \item{}{\code{aggregation="mean"}: Function or character scalar. Used to |
|
305 |
+#' \item{\code{aggregation="mean"}:}{ Function or character scalar. Used to |
|
306 | 306 |
#' aggregate values in windows or for collapsing overlapping items. The |
307 | 307 |
#' function has to accept a numeric vector as a single input parameter and has |
308 | 308 |
#' to return a numeric scalar with the aggregated value. Alternatively, one of |
... | ... |
@@ -310,223 +310,223 @@ |
310 | 310 |
#' \code{max} or \code{extreme} can be supplied as a character scalar. Defaults |
311 | 311 |
#' to \code{mean}.} |
312 | 312 |
#' |
313 |
-#' \item{}{\code{missingAsZero=TRUE}: Logical scalar. Defines how the missing |
|
313 |
+#' \item{\code{missingAsZero=TRUE}:}{ Logical scalar. Defines how the missing |
|
314 | 314 |
#' values are treated in the aggregation procedure with running window. Setting |
315 | 315 |
#' it to \code{TRUE} fills empty positions with zeros, which is default. |
316 | 316 |
#' \code{FALSE} fills empty positions with \code{NA}.} |
317 | 317 |
#' |
318 |
-#' \item{}{\code{alpha.confint=0.3}: Numeric scalar. The transparency for the |
|
318 |
+#' \item{\code{alpha.confint=0.3}:}{ Numeric scalar. The transparency for the |
|
319 | 319 |
#' confidence intervalls in confint-type plots.} |
320 | 320 |
#' |
321 |
-#' \item{}{\code{amount=NULL}: Numeric scalar. Amount of jittering in xy-type |
|
321 |
+#' \item{\code{amount=NULL}:}{ Numeric scalar. Amount of jittering in xy-type |
|
322 | 322 |
#' plots. See \code{\link{panel.xyplot}} for details.} |
323 | 323 |
#' |
324 |
-#' \item{}{\code{baseline=NULL}: Numeric scalar. Y-axis position of an optional |
|
324 |
+#' \item{\code{baseline=NULL}:}{ Numeric scalar. Y-axis position of an optional |
|
325 | 325 |
#' baseline. This parameter has a special meaning for mountain-type and |
326 | 326 |
#' polygon-type plots, see the 'Details' section in |
327 | 327 |
#' \code{\linkS4class{DataTrack}} for more information.} |
328 | 328 |
#' |
329 |
-#' \item{}{\code{box.legend=FALSE}: Logical scalar. Draw a box around a |
|
329 |
+#' \item{\code{box.legend=FALSE}:}{ Logical scalar. Draw a box around a |
|
330 | 330 |
#' legend.} |
331 | 331 |
#' |
332 |
-#' \item{}{\code{box.ratio=1}: Numeric scalar. Parameter controlling the |
|
332 |
+#' \item{\code{box.ratio=1}:}{ Numeric scalar. Parameter controlling the |
|
333 | 333 |
#' boxplot appearance. See \code{\link{panel.bwplot}} for details.} |
334 | 334 |
#' |
335 |
-#' \item{}{\code{box.width=NULL}: Numeric scalar. Parameter controlling the |
|
335 |
+#' \item{\code{box.width=NULL}:}{ Numeric scalar. Parameter controlling the |
|
336 | 336 |
#' boxplot appearance. See \code{\link{panel.bwplot}} for details.} |
337 | 337 |
#' |
338 |
-#' \item{}{\code{grid=FALSE}: Logical vector. Draw a line grid under the track |
|
338 |
+#' \item{\code{grid=FALSE}:}{ Logical vector. Draw a line grid under the track |
|
339 | 339 |
#' content.} |
340 | 340 |
#' |
341 |
-#' \item{}{\code{cex.legend=0.8}: Numeric scalar. The size factor for the |
|
341 |
+#' \item{\code{cex.legend=0.8}:}{ Numeric scalar. The size factor for the |
|
342 | 342 |
#' legend text.} |
343 | 343 |
#' |
344 |
-#' \item{}{\code{cex.sampleNames=NULL}: Numeric scalar. The size factor for the |
|
344 |
+#' \item{\code{cex.sampleNames=NULL}:}{ Numeric scalar. The size factor for the |
|
345 | 345 |
#' sample names text in heatmap or horizon plots. Defaults to an automatic |
346 | 346 |
#' setting.} |
347 | 347 |
#' |
348 |
-#' \item{}{\code{cex=0.7}: Numeric scalar. The default pixel size for plotting |
|
348 |
+#' \item{\code{cex=0.7}:}{ Numeric scalar. The default pixel size for plotting |
|
349 | 349 |
#' symbols.} |
350 | 350 |
#' |
351 |
-#' \item{}{\code{coef=1.5}: Numeric scalar. Parameter controlling the boxplot |
|
351 |
+#' \item{\code{coef=1.5}:}{ Numeric scalar. Parameter controlling the boxplot |
|
352 | 352 |
#' appearance. See \code{\link{panel.bwplot}} for details.} |
353 | 353 |
#' |
354 |
-#' \item{}{\code{col.baseline=NULL}: Character scalar. Color for the optional |
|
354 |
+#' \item{\code{col.baseline=NULL}:}{ Character scalar. Color for the optional |
|
355 | 355 |
#' baseline, defaults to the setting of \code{col}.} |
356 | 356 |
#' |
357 |
-#' \item{}{\code{col.confint=NA}: Character vector. Border colors for the |
|
357 |
+#' \item{\code{col.confint=NA}:}{ Character vector. Border colors for the |
|
358 | 358 |
#' confidence intervals for confint-type plots.} |
359 | 359 |
#' |
360 |
-#' \item{}{\code{col.boxplotFrame="#808080"}: Character scalar. Line color of |
|
360 |
+#' \item{\code{col.boxplotFrame="#808080"}:}{ Character scalar. Line color of |
|
361 | 361 |
#' the frame around grouped boxplots.} |
362 | 362 |
#' |
363 |
-#' \item{}{\code{col.histogram="#808080"}: Character scalar. Line color in |
|
363 |
+#' \item{\code{col.histogram="#808080"}:}{ Character scalar. Line color in |
|
364 | 364 |
#' histogram-type plots.} |
365 | 365 |
#' |
366 |
-#' \item{}{\code{col.horizon=NA}: The line color for the segments in the |
|
366 |
+#' \item{\code{col.horizon=NA}:}{ The line color for the segments in the |
|
367 | 367 |
#' \code{horizon}-type plot. See \code{\link{horizonplot}} for details.} |
368 | 368 |
#' |
369 |
-#' \item{}{\code{col.mountain=NULL}: Character scalar. Line color in |
|
369 |
+#' \item{\code{col.mountain=NULL}:}{ Character scalar. Line color in |
|
370 | 370 |
#' mountain-type and polygon-type plots, defaults to the setting of |
371 | 371 |
#' \code{col}.} |
372 | 372 |
#' |
373 |
-#' \item{}{\code{col.sampleNames="white"}: Character or integer scalar. The |
|
373 |
+#' \item{\code{col.sampleNames="white"}:}{ Character or integer scalar. The |
|
374 | 374 |
#' color used for the sample names in heatmap plots.} |
375 | 375 |
#' |
376 |
-#' \item{}{\code{col=c("#0080ff", "#ff00ff", "darkgreen", "#ff0000", "orange", |
|
377 |
-#' "#00ff00", "brown")}: Character or integer vector. The color used for all |
|
376 |
+#' \item{\code{col=c("#0080ff", "#ff00ff", "darkgreen", "#ff0000", "orange", |
|
377 |
+#' "#00ff00", "brown")}:}{ Character or integer vector. The color used for all |
|
378 | 378 |
#' line and symbol elements, unless there is a more specific control defined |
379 | 379 |
#' elsewhere. Unless \code{groups} are specified, only the first color in the |
380 | 380 |
#' vector is usually regarded.} |
381 | 381 |
#' |
382 |
-#' \item{}{\code{collapse=FALSE}: Logical scalar. Collapse overlapping ranges |
|
382 |
+#' \item{\code{collapse=FALSE}:}{ Logical scalar. Collapse overlapping ranges |
|
383 | 383 |
#' and aggregate the underlying data.} |
384 | 384 |
#' |
385 |
-#' \item{}{\code{degree=1}: Numeric scalar. Parameter controlling the loess |
|
385 |
+#' \item{\code{degree=1}:}{ Numeric scalar. Parameter controlling the loess |
|
386 | 386 |
#' calculation for smooth and mountain-type plots. See |
387 | 387 |
#' \code{\link{panel.loess}} for details.} |
388 | 388 |
#' |
389 |
-#' \item{}{\code{do.out=TRUE}: Logical scalar. Parameter controlling the |
|
389 |
+#' \item{\code{do.out=TRUE}:}{ Logical scalar. Parameter controlling the |
|
390 | 390 |
#' boxplot appearance. See \code{\link{panel.bwplot}} for details.} |
391 | 391 |
#' |
392 |
-#' \item{}{\code{evaluation=50}: Numeric scalar. Parameter controlling the |
|
392 |
+#' \item{\code{evaluation=50}:}{ Numeric scalar. Parameter controlling the |
|
393 | 393 |
#' loess calculation for smooth and mountain-type plots. See |
394 | 394 |
#' \code{\link{panel.loess}} for details.} |
395 | 395 |
#' |
396 |
-#' \item{}{\code{factor=0.5}: Numeric scalar. Factor to control amount of |
|
396 |
+#' \item{\code{factor=0.5}:}{ Numeric scalar. Factor to control amount of |
|
397 | 397 |
#' jittering in xy-type plots. See \code{\link{panel.xyplot}} for details.} |
398 | 398 |
#' |
399 |
-#' \item{}{\code{family="symmetric"}: Character scalar. Parameter controlling |
|
399 |
+#' \item{\code{family="symmetric"}:}{ Character scalar. Parameter controlling |
|
400 | 400 |
#' the loess calculation for smooth and mountain-type plots. See |
401 | 401 |
#' \code{\link{panel.loess}} for details.} |
402 | 402 |
#' |
403 |
-#' \item{}{\code{fill.confint=NULL}: Character vector. Fill colors for the |
|
403 |
+#' \item{\code{fill.confint=NULL}:}{ Character vector. Fill colors for the |
|
404 | 404 |
#' confidence intervals for confint-type plots.} |
405 | 405 |
#' |
406 |
-#' \item{}{\code{fill.histogram=NULL}: Character scalar. Fill color in |
|
406 |
+#' \item{\code{fill.histogram=NULL}:}{ Character scalar. Fill color in |
|
407 | 407 |
#' histogram-type plots, defaults to the setting of \code{fill}.} |
408 | 408 |
#' |
409 |
-#' \item{}{\code{fill.horizon=c("#B41414", "#E03231", "#F7A99C", "#9FC8DC", |
|
410 |
-#' "#468CC8", "#0165B3")}: The fill colors for the segments in the |
|
409 |
+#' \item{\code{fill.horizon=c("#B41414", "#E03231", "#F7A99C", "#9FC8DC", |
|
410 |
+#' "#468CC8", "#0165B3")}:}{ The fill colors for the segments in the |
|
411 | 411 |
#' \code{horizon}-type plot. This should be a vector of length six, where the |
412 | 412 |
#' first three entries are the colors for positive changes, and the latter |
413 | 413 |
#' three entries are the colors for negative changes. Defaults to a red-blue |
414 | 414 |
#' color scheme. See \code{\link{horizonplot}} for details.} |
415 | 415 |
#' |
416 |
-#' \item{}{\code{fill.mountain=c("#CCFFFF", "#FFCCFF")}: Character vector of |
|
416 |
+#' \item{\code{fill.mountain=c("#CCFFFF", "#FFCCFF")}:}{ Character vector of |
|
417 | 417 |
#' length 2. Fill color in mountain-type and polygon-type plots.} |
418 | 418 |
#' |
419 |
-#' \item{}{\code{fontface.legend=NULL}: Integer or character scalar. The font |
|
419 |
+#' \item{\code{fontface.legend=NULL}:}{ Integer or character scalar. The font |
|
420 | 420 |
#' face for the legend text.} |
421 | 421 |
#' |
422 |
-#' \item{}{\code{fontfamily.legend=NULL}: Integer or character scalar. The font |
|
422 |
+#' \item{\code{fontfamily.legend=NULL}:}{ Integer or character scalar. The font |
|
423 | 423 |
#' family for the legend text.} |
424 | 424 |
#' |
425 |
-#' \item{}{\code{fontsize.legend=NULL}: Numeric scalar. The pixel size for the |
|
425 |
+#' \item{\code{fontsize.legend=NULL}:}{ Numeric scalar. The pixel size for the |
|
426 | 426 |
#' legend text.} |
427 | 427 |
#' |
428 |
-#' \item{}{\code{fontcolor.legend="#808080"}: Integer or character scalar. The |
|
428 |
+#' \item{\code{fontcolor.legend="#808080"}:}{ Integer or character scalar. The |
|
429 | 429 |
#' font color for the legend text.} |
430 | 430 |
#' |
431 |
-#' \item{}{\code{gradient=c("#F7FBFF", "#DEEBF7", "#C6DBEF", "#9ECAE1", |
|
432 |
-#' "#6BAED6", "#4292C6", "#2171B5", "#08519C", "#08306B")}: Character vector. |
|
431 |
+#' \item{\code{gradient=c("#F7FBFF", "#DEEBF7", "#C6DBEF", "#9ECAE1", |
|
432 |
+#' "#6BAED6", "#4292C6", "#2171B5", "#08519C", "#08306B")}:}{ Character vector. |
|
433 | 433 |
#' The base colors for the \code{gradient} plotting type or the \code{heatmap} |
434 | 434 |
#' type with a single group. When plotting heatmaps with more than one group, |
435 | 435 |
#' the \code{col} parameter can be used to control the group color scheme, |
436 | 436 |
#' however the gradient will always be from white to 'col' and thus does not |
437 | 437 |
#' offer as much flexibility as this \code{gradient} parameter.} |
438 | 438 |
#' |
439 |
-#' \item{}{\code{groups=NULL}: Vector coercable to a factor. Optional sample |
|
439 |
+#' \item{\code{groups=NULL}:}{ Vector coercable to a factor. Optional sample |
|
440 | 440 |
#' grouping. See 'Details' section in \code{\linkS4class{DataTrack}} for |
441 | 441 |
#' further information.} |
442 | 442 |
#' |
443 |
-#' \item{}{\code{horizon.origin=0}: The baseline relative to which changes are |
|
443 |
+#' \item{\code{horizon.origin=0}:}{ The baseline relative to which changes are |
|
444 | 444 |
#' indicated on the \code{horizon}-type plot. See \code{\link{horizonplot}} for |
445 | 445 |
#' details.} |
446 | 446 |
#' |
447 |
-#' \item{}{\code{horizon.scale=NULL}: The scale for each of the segments in the |
|
447 |
+#' \item{\code{horizon.scale=NULL}:}{ The scale for each of the segments in the |
|
448 | 448 |
#' \code{horizon}-type plot. Defaults to 1/3 of the absolute data range. See |
449 | 449 |
#' \code{\link{horizonplot}} for details.} |
450 | 450 |
#' |
451 |
-#' \item{}{\code{jitter.x=FALSE}: Logical scalar. Toggle on jittering on the x |
|
451 |
+#' \item{\code{jitter.x=FALSE}:}{ Logical scalar. Toggle on jittering on the x |
|
452 | 452 |
#' axis in xy-type plots. See \code{\link{panel.xyplot}} for details.} |
453 | 453 |
#' |
454 |
-#' \item{}{\code{jitter.y=FALSE}: Logical scalar. Toggle off jittering on the y |
|
454 |
+#' \item{\code{jitter.y=FALSE}:}{ Logical scalar. Toggle off jittering on the y |
|
455 | 455 |
#' axis in xy-type plots. See \code{\link{panel.xyplot}} for details.} |
456 | 456 |
#' |
457 |
-#' \item{}{\code{levels.fos=NULL}: Numeric scalar. Parameter controlling the |
|
457 |
+#' \item{\code{levels.fos=NULL}:}{ Numeric scalar. Parameter controlling the |
|
458 | 458 |
#' boxplot appearance. See \code{\link{panel.bwplot}} for details.} |
459 | 459 |
#' |
460 |
-#' \item{}{\code{legend=TRUE}: Boolean triggering the addition of a legend to |
|
460 |
+#' \item{\code{legend=TRUE}:}{ Boolean triggering the addition of a legend to |
|
461 | 461 |
#' the track to indicate groups. This only has an effect if at least two groups |
462 | 462 |
#' are present.} |
463 | 463 |
#' |
464 |
-#' \item{}{\code{lineheight.legend=NULL}: Numeric scalar. The line height for |
|
464 |
+#' \item{\code{lineheight.legend=NULL}:}{ Numeric scalar. The line height for |
|
465 | 465 |
#' the legend text.} |
466 | 466 |
#' |
467 |
-#' \item{}{\code{lty.baseline=NULL}: Character or numeric scalar. Line type of |
|
467 |
+#' \item{\code{lty.baseline=NULL}:}{ Character or numeric scalar. Line type of |
|
468 | 468 |
#' the optional baseline, defaults to the setting of \code{lty}.} |
469 | 469 |
#' |
470 |
-#' \item{}{\code{lty.mountain=NULL}: Character or numeric scalar. Line type in |
|
470 |
+#' \item{\code{lty.mountain=NULL}:}{ Character or numeric scalar. Line type in |
|
471 | 471 |
#' mountain-type and polygon-type plots, defaults to the setting of |
472 | 472 |
#' \code{lty}.} |
473 | 473 |
#' |
474 |
-#' \item{}{\code{lwd.baseline=NULL}: Numeric scalar. Line width of the optional |
|
474 |
+#' \item{\code{lwd.baseline=NULL}:}{ Numeric scalar. Line width of the optional |
|
475 | 475 |
#' baseline, defaults to the setting of \code{lwd}.} |
476 | 476 |
#' |
477 |
-#' \item{}{\code{lwd.mountain=NULL}: Numeric scalar. Line width in |
|
477 |
+#' \item{\code{lwd.mountain=NULL}:}{ Numeric scalar. Line width in |
|
478 | 478 |
#' mountain-type and polygon-type plots, defaults to the setting of |
479 | 479 |
#' \code{lwd}.} |
480 | 480 |
#' |
481 |
-#' \item{}{\code{min.distance=0}: Numeric scalar. The mimimum distance in pixel |
|
481 |
+#' \item{\code{min.distance=0}:}{ Numeric scalar. The mimimum distance in pixel |
|
482 | 482 |
#' below which to collapse ranges.} |
483 | 483 |
#' |
484 |
-#' \item{}{\code{na.rm=FALSE}: Boolean controlling whether to discard all NA |
|
484 |
+#' \item{\code{na.rm=FALSE}:}{ Boolean controlling whether to discard all NA |
|
485 | 485 |
#' values when plotting or to keep empty spaces for NAs} |
486 | 486 |
#' |
487 |
-#' \item{}{\code{ncolor=100}: Integer scalar. The number of colors for the |
|
487 |
+#' \item{\code{ncolor=100}:}{ Integer scalar. The number of colors for the |
|
488 | 488 |
#' 'gradient' plotting type} |
489 | 489 |
#' |
490 |
-#' \item{}{\code{notch.frac=0.5}: Numeric scalar. Parameter controlling the |
|
490 |
+#' \item{\code{notch.frac=0.5}:}{ Numeric scalar. Parameter controlling the |
|
491 | 491 |
#' boxplot appearance. See \code{\link{panel.bwplot}} for details.} |
492 | 492 |
#' |
493 |
-#' \item{}{\code{notch=FALSE}: Logical scalar. Parameter controlling the |
|
493 |
+#' \item{\code{notch=FALSE}:}{ Logical scalar. Parameter controlling the |
|
494 | 494 |
#' boxplot appearance. See \code{\link{panel.bwplot}} for details.} |
495 | 495 |
#' |
496 |
-#' \item{}{\code{pch=20}: Integer scalar. The type of glyph used for plotting |
|
496 |
+#' \item{\code{pch=20}:}{ Integer scalar. The type of glyph used for plotting |
|
497 | 497 |
#' symbols.} |
498 | 498 |
#' |
499 |
-#' \item{}{\code{separator=0}: Numeric scalar. Number of pixels used to |
|
499 |
+#' \item{\code{separator=0}:}{ Numeric scalar. Number of pixels used to |
|
500 | 500 |
#' separate individual samples in heatmap- and horizon-type plots.} |
501 | 501 |
#' |
502 |
-#' \item{}{\code{showColorBar=TRUE}: Boolean. Indicate the data range color |
|
502 |
+#' \item{\code{showColorBar=TRUE}:}{ Boolean. Indicate the data range color |
|
503 | 503 |
#' mapping in the axis for 'heatmap' or 'gradient' types.} |
504 | 504 |
#' |
505 |
-#' \item{}{\code{showSampleNames=FALSE}: Boolean. Display the names of the |
|
505 |
+#' \item{\code{showSampleNames=FALSE}:}{ Boolean. Display the names of the |
|
506 | 506 |
#' individual samples in a heatmap or a horizon plot.} |
507 | 507 |
#' |
508 |
-#' \item{}{\code{size=NULL}: Numeric scalar. The relative size of the track. |
|
508 |
+#' \item{\code{size=NULL}:}{ Numeric scalar. The relative size of the track. |
|
509 | 509 |
#' Can be overridden in the \code{\link{plotTracks}} function. By default the |
510 | 510 |
#' size will be set automatically based on the selected plotting type.} |
511 | 511 |
#' |
512 |
-#' \item{}{\code{span=0.2}: Numeric scalar. Parameter controlling the loess |
|
512 |
+#' \item{\code{span=0.2}:}{ Numeric scalar. Parameter controlling the loess |
|
513 | 513 |
#' calculation for smooth and mountain-type plots. See |
514 | 514 |
#' \code{\link{panel.loess}} for details.} |
515 | 515 |
#' |
516 |
-#' \item{}{\code{stackedBars=TRUE}: Logical scalar. When there are several data |
|
516 |
+#' \item{\code{stackedBars=TRUE}:}{ Logical scalar. When there are several data |
|
517 | 517 |
#' groups, draw the histogram-type plots as stacked barplots or grouped side by |
518 | 518 |
#' side.} |
519 | 519 |
#' |
520 |
-#' \item{}{\code{stats=X[[i]]}: Function. Parameter controlling the boxplot |
|
520 |
+#' \item{\code{stats=X[[i]]}:}{ Function. Parameter controlling the boxplot |
|
521 | 521 |
#' appearance. See \code{\link{panel.bwplot}} for details.} |
522 | 522 |
#' |
523 |
-#' \item{}{\code{transformation=NULL}: Function. Applied to the data matrix |
|
523 |
+#' \item{\code{transformation=NULL}:}{ Function. Applied to the data matrix |
|
524 | 524 |
#' prior to plotting or when calling the \code{score} method. The function |
525 | 525 |
#' should accept exactly one input argument and its return value needs to be a |
526 | 526 |
#' numeric vector which can be coerced back into a data matrix of identical |
527 | 527 |
#' dimensionality as the input data.} |
528 | 528 |
#' |
529 |
-#' \item{}{\code{type="p"}: Character vector. The plot type, one or several in |
|
529 |
+#' \item{\code{type="p"}:}{ Character vector. The plot type, one or several in |
|
530 | 530 |
#' \code{p},\code{l}, \code{b}, \code{a}, \code{a_confint}, \code{s}, \code{g}, |
531 | 531 |
#' \code{r}, \code{S}, \code{confint}, \code{smooth}, \code{histogram}, |
532 | 532 |
#' \code{mountain}, \code{polygon}, \code{h}, \code{boxplot}, \code{gradient}, |
... | ... |
@@ -534,10 +534,10 @@ |
534 | 534 |
#' \code{\linkS4class{DataTrack}} for more information on the individual |
535 | 535 |
#' plotting types.} |
536 | 536 |
#' |
537 |
-#' \item{}{\code{varwidth=FALSE}: Logical scalar. Parameter controlling the |
|
537 |
+#' \item{\code{varwidth=FALSE}:}{ Logical scalar. Parameter controlling the |
|
538 | 538 |
#' boxplot appearance. See \code{\link{panel.bwplot}} for details.} |
539 | 539 |
#' |
540 |
-#' \item{}{\code{window=NULL}: Numeric or character scalar. Aggregate the rows |
|
540 |
+#' \item{\code{window=NULL}:}{ Numeric or character scalar. Aggregate the rows |
|
541 | 541 |
#' values of the data matrix to \code{window} equally sized slices on the data |
542 | 542 |
#' range using the method defined in \code{aggregation}. If negative, apply a |
543 | 543 |
#' running window of size \code{windowSize} using the same aggregation method. |
... | ... |
@@ -545,13 +545,13 @@ |
545 | 545 |
#' determine the optimal window size to avoid overplotting, and \code{fixed} |
546 | 546 |
#' uses fixed-size windows of size \code{windowSize}.} |
547 | 547 |
#' |
548 |
-#' \item{}{\code{windowSize=NULL}: Numeric scalar. The size of the running |
|
548 |
+#' \item{\code{windowSize=NULL}:}{ Numeric scalar. The size of the running |
|
549 | 549 |
#' window when the value of \code{window} is negative.} |
550 | 550 |
#' |
551 |
-#' \item{}{\code{ylim=NULL}: Numeric vector of length 2. The range of the |
|
551 |
+#' \item{\code{ylim=NULL}:}{ Numeric vector of length 2. The range of the |
|
552 | 552 |
#' y-axis scale.} |
553 | 553 |
#' |
554 |
-#' \item{}{\code{yTicksAt=NULL}: Numeric vector. The points at which y-axis |
|
554 |
+#' \item{\code{yTicksAt=NULL}:}{ Numeric vector. The points at which y-axis |
|
555 | 555 |
#' tick-marks are to be drawn. By default, when \code{NULL}, tickmark locations |
556 | 556 |
#' are computed.} |
557 | 557 |
#' |
... | ... |
@@ -561,204 +561,204 @@ |
561 | 561 |
#' |
562 | 562 |
#' \describe{ |
563 | 563 |
#' |
564 |
-#' \item{}{\code{alpha=1}: Numeric scalar. The transparency for all track |
|
564 |
+#' \item{\code{alpha=1}:}{ Numeric scalar. The transparency for all track |
|
565 | 565 |
#' items.} |
566 | 566 |
#' |
567 |
-#' \item{}{\code{alpha.title=NULL}: Numeric scalar. The transparency for the |
|
567 |
+#' \item{\code{alpha.title=NULL}:}{ Numeric scalar. The transparency for the |
|
568 | 568 |
#' title panel.} |
569 | 569 |
#' |
570 |
-#' \item{}{\code{background.panel="transparent"}: Integer or character scalar. |
|
570 |
+#' \item{\code{background.panel="transparent"}:}{ Integer or character scalar. |
|
571 | 571 |
#' The background color of the content panel.} |
572 | 572 |
#' |
573 |
-#' \item{}{\code{background.title="lightgray"}: Integer or character scalar. |
|
573 |
+#' \item{\code{background.title="lightgray"}:}{ Integer or character scalar. |
|
574 | 574 |
#' The background color for the title panel.} |
575 | 575 |
#' |
576 |
-#' \item{}{\code{background.legend="transparent"}: Integer or character scalar. |
|
576 |
+#' \item{\code{background.legend="transparent"}:}{ Integer or character scalar. |
|
577 | 577 |
#' The background color for the legend.} |
578 | 578 |
#' |
579 |
-#' \item{}{\code{cex.axis=NULL}: Numeric scalar. The expansion factor for the |
|
579 |
+#' \item{\code{cex.axis=NULL}:}{ Numeric scalar. The expansion factor for the |
|
580 | 580 |
#' axis annotation. Defaults to \code{NULL}, in which case it is automatically |
581 | 581 |
#' determined based on the available space.} |
582 | 582 |
#' |
583 |
-#' \item{}{\code{cex.title=NULL}: Numeric scalar. The expansion factor for the |
|
583 |
+#' \item{\code{cex.title=NULL}:}{ Numeric scalar. The expansion factor for the |
|
584 | 584 |
#' title panel. This effects the fontsize of both the title and the axis, if |
585 | 585 |
#' any. Defaults to \code{NULL}, which means that the text size is |
586 | 586 |
#' automatically adjusted to the available space.} |
587 | 587 |
#' |
588 |
-#' \item{}{\code{col.axis="white"}: Integer or character scalar. The font and |
|
588 |
+#' \item{\code{col.axis="white"}:}{ Integer or character scalar. The font and |
|
589 | 589 |
#' line color for the y axis, if any.} |
590 | 590 |
#' |
591 |
-#' \item{}{\code{col.border.title="white"}: Integer or character scalar. The |
|
591 |
+#' \item{\code{col.border.title="white"}:}{ Integer or character scalar. The |
|
592 | 592 |
#' border color for the title panels.} |
593 | 593 |
#' |
594 |
-#' \item{}{\code{col.frame="lightgray"}: Integer or character scalar. The line |
|
594 |
+#' \item{\code{col.frame="lightgray"}:}{ Integer or character scalar. The line |
|
595 | 595 |
#' color used for the panel frame, if \code{frame==TRUE}} |
596 | 596 |
#' |
597 |
-#' \item{}{\code{col.grid="#808080"}: Integer or character scalar. Default |
|
597 |
+#' \item{\code{col.grid="#808080"}:}{ Integer or character scalar. Default |
|
598 | 598 |
#' line color for grid lines, both when \code{type=="g"} in |
599 | 599 |
#' \code{\linkS4class{DataTrack}}s and when display parameter \code{grid==TRUE}.} |
600 | 600 |
#' |
601 |
-#' \item{}{\code{col.line=NULL}: Integer or character scalar. Default colors |
|
601 |
+#' \item{\code{col.line=NULL}:}{ Integer or character scalar. Default colors |
|
602 | 602 |
#' for plot lines. Usually the same as the global \code{col} parameter.} |
603 | 603 |
#' |
604 |
-#' \item{}{\code{col.symbol=NULL}: Integer or character scalar. Default colors |
|
604 |
+#' \item{\code{col.symbol=NULL}:}{ Integer or character scalar. Default colors |
|
605 | 605 |
#' for plot symbols. Usually the same as the global \code{col} parameter.} |
606 | 606 |
#' |
607 |
-#' \item{}{\code{col.title="white"}: Integer or character scalar. The border |
|
607 |
+#' \item{\code{col.title="white"}:}{ Integer or character scalar. The border |
|
608 | 608 |
#' color for the title panels} |
609 | 609 |
#' |
610 |
-#' \item{}{\code{fill="lightgray"}: Integer or character scalar. Default fill |
|
610 |
+#' \item{\code{fill="lightgray"}:}{ Integer or character scalar. Default fill |
|
611 | 611 |
#' color setting for all plotting elements, unless there is a more specific |
612 | 612 |
#' control defined elsewhere.} |
613 | 613 |
#' |
614 |
-#' \item{}{\code{fontcolor="black"}: Integer or character scalar. The font |
|
614 |
+#' \item{\code{fontcolor="black"}:}{ Integer or character scalar. The font |
|
615 | 615 |
#' color for all text, unless a more specific definition exists.} |
616 | 616 |
#' |
617 |
-#' \item{}{\code{fontface.title=2}: Integer or character scalar. The font face |
|
617 |
+#' \item{\code{fontface.title=2}:}{ Integer or character scalar. The font face |
|
618 | 618 |
#' for the title panels.} |
619 | 619 |
#' |
620 |
-#' \item{}{\code{fontface=1}: Integer or character scalar. The font face for |
|
620 |
+#' \item{\code{fontface=1}:}{ Integer or character scalar. The font face for |
|
621 | 621 |
#' all text, unless a more specific definition exists.} |
622 | 622 |
#' |
623 |
-#' \item{}{\code{fontfamily.title="sans"}: Integer or character scalar. The |
|
623 |
+#' \item{\code{fontfamily.title="sans"}:}{ Integer or character scalar. The |
|
624 | 624 |
#' font family for the title panels.} |
625 | 625 |
#' |
626 |
-#' \item{}{\code{fontfamily="sans"}: Integer or character scalar. The font |
|
626 |
+#' \item{\code{fontfamily="sans"}:}{ Integer or character scalar. The font |
|
627 | 627 |
#' family for all text, unless a more specific definition exists.} |
628 | 628 |
#' |
629 |
-#' \item{}{\code{fontsize=12}: Numeric scalar. The font size for all text, |
|
629 |
+#' \item{\code{fontsize=12}:}{ Numeric scalar. The font size for all text, |
|
630 | 630 |
#' unless a more specific definition exists.} |
631 | 631 |
#' |
632 |
-#' \item{}{\code{frame=FALSE}: Boolean. Draw a frame around the track when |
|
632 |
+#' \item{\code{frame=FALSE}:}{ Boolean. Draw a frame around the track when |
|
633 | 633 |
#' plotting.} |
634 | 634 |
#' |
635 |
-#' \item{}{\code{h=-1}: Integer scalar. Parameter controlling the number of |
|
635 |
+#' \item{\code{h=-1}:}{ Integer scalar. Parameter controlling the number of |
|
636 | 636 |
#' horizontal grid lines, see \code{\link{panel.grid}} for details.} |
637 | 637 |
#' |
638 |
-#' \item{}{\code{lineheight=1}: Numeric scalar. The font line height for all |
|
638 |
+#' \item{\code{lineheight=1}:}{ Numeric scalar. The font line height for all |
|
639 | 639 |
#' text, unless a more specific definition exists.} |
640 | 640 |
#' |
641 |
-#' \item{}{\code{lty.grid="solid"}: Integer or character scalar. Default line |
|
641 |
+#' \item{\code{lty.grid="solid"}:}{ Integer or character scalar. Default line |
|
642 | 642 |
#' type for grid lines, both when \code{type=="g"} in \code{\linkS4class{DataTrack}}s |
643 | 643 |
#' and when display parameter \code{grid==TRUE}.} |
644 | 644 |
#' |
645 |
-#' \item{}{\code{lty="solid"}: Numeric scalar. Default line type setting for |
|
645 |
+#' \item{\code{lty="solid"}:}{ Numeric scalar. Default line type setting for |
|
646 | 646 |
#' all plotting elements, unless there is a more specific control defined |
647 | 647 |
#' elsewhere.} |
648 | 648 |
#' |
649 |
-#' \item{}{\code{lwd.border.title=1}: Integer scalar. The border width for the |
|
649 |
+#' \item{\code{lwd.border.title=1}:}{ Integer scalar. The border width for the |
|
650 | 650 |
#' title panels.} |
651 | 651 |
#' |
652 |
-#' \item{}{\code{lwd.title=1}: Integer scalar. The border width for the title |
|
652 |
+#' \item{\code{lwd.title=1}:}{ Integer scalar. The border width for the title |
|
653 | 653 |
#' panels} |
654 | 654 |
#' |
655 |
-#' \item{}{\code{lwd.grid=1}: Numeric scalar. Default line width for grid |
|
655 |
+#' \item{\code{lwd.grid=1}:}{ Numeric scalar. Default line width for grid |
|
656 | 656 |
#' lines, both when \code{type=="g"} in \code{\linkS4class{DataTrack}}s and when |
657 | 657 |
#' display parameter \code{grid==TRUE}.} |
658 | 658 |
#' |
659 |
-#' \item{}{\code{lwd=1}: Numeric scalar. Default line width setting for all |
|
659 |
+#' \item{\code{lwd=1}:}{ Numeric scalar. Default line width setting for all |
|
660 | 660 |
#' plotting elements, unless there is a more specific control defined |
661 | 661 |
#' elsewhere.} |
662 | 662 |
#' |
663 |
-#' \item{}{\code{min.height=3}: Numeric scalar. The minimum range height in |
|
663 |
+#' \item{\code{min.height=3}:}{ Numeric scalar. The minimum range height in |
|
664 | 664 |
#' pixels to display. All ranges are expanded to this size in order to avoid |
665 | 665 |
#' rendering issues. See \code{\link{collapsing}} for details.} |
666 | 666 |
#' |
667 |
-#' \item{}{\code{min.width=1}: Numeric scalar. The minimum range width in |
|
667 |
+#' \item{\code{min.width=1}:}{ Numeric scalar. The minimum range width in |
|
668 | 668 |
#' pixels to display. All ranges are expanded to this size in order to avoid |
669 | 669 |
#' rendering issues. See \code{\link{collapsing}} for details.} |
670 | 670 |
#' |
671 |
-#' \item{}{\code{reverseStrand=FALSE}: Logical scalar. Set up the plotting |
|
671 |
+#' \item{\code{reverseStrand=FALSE}:}{ Logical scalar. Set up the plotting |
|
672 | 672 |
#' coordinates in 3' -> 5' direction if \code{TRUE}. This will effectively |
673 | 673 |
#' mirror the plot on the vertical axis.} |
674 | 674 |
#' |
675 |
-#' \item{}{\code{rotation.title=90}: The rotation angle for the text in the |
|
675 |
+#' \item{\code{rotation.title=90}:}{ The rotation angle for the text in the |
|
676 | 676 |
#' title panel. Even though this can be adjusted, the automatic resizing of the |
677 | 677 |
#' title panel will currently not work, so use at own risk.} |
678 | 678 |
#' |
679 |
-#' \item{}{\code{rotation=0}: The rotation angle for all text unless a more |
|
679 |
+#' \item{\code{rotation=0}:}{ The rotation angle for all text unless a more |
|
680 | 680 |
#' specific definiton exists.} |
681 | 681 |
#' |
682 |
-#' \item{}{\code{showAxis=TRUE}: Boolean controlling whether to plot a y axis |
|
682 |
+#' \item{\code{showAxis=TRUE}:}{ Boolean controlling whether to plot a y axis |
|
683 | 683 |
#' (only applies to track types where axes are implemented).} |
684 | 684 |
#' |
685 |
-#' \item{}{\code{showTitle=TRUE}: Boolean controlling whether to plot a title |
|
685 |
+#' \item{\code{showTitle=TRUE}:}{ Boolean controlling whether to plot a title |
|
686 | 686 |
#' panel. Although this can be set individually for each track, in multi-track |
687 | 687 |
#' plots as created by \code{\link{plotTracks}} there will still be an empty |
688 | 688 |
#' placeholder in case any of the other tracks include a title. The same holds |
689 | 689 |
#' true for axes. Note that the the title panel background color could be set |
690 | 690 |
#' to transparent in order to completely hide it.} |
691 | 691 |
#' |
692 |
-#' \item{}{\code{v=-1}: Integer scalar. Parameter controlling the number of |
|
692 |
+#' \item{\code{v=-1}:}{ Integer scalar. Parameter controlling the number of |
|
693 | 693 |
#' vertical grid lines, see \code{\link{panel.grid}} for details.} |
694 | 694 |
#' |
695 | 695 |
#' } |
696 | 696 |
#' |
697 | 697 |
#' } |
698 | 698 |
#' |
699 |
-#' \item{IdeogramTrack}{: |
|
699 |
+#' \item{IdeogramTrack:}{ |
|
700 | 700 |
#' |
701 | 701 |
#' \describe{ |
702 | 702 |
#' |
703 |
-#' \item{}{\code{background.title="transparent"}: Character scalar. The |
|
703 |
+#' \item{\code{background.title="transparent"}:}{ Character scalar. The |
|
704 | 704 |
#' background color for the title panel. Defaults to omit the background.} |
705 | 705 |
#' |
706 |
-#' \item{}{\code{bevel=0.45}: Numeric scalar, between 0 and 1. The level of |
|
706 |
+#' \item{\code{bevel=0.45}:}{ Numeric scalar, between 0 and 1. The level of |
|
707 | 707 |
#' smoothness for the two ends of the ideogram.} |
708 | 708 |
#' |
709 |
-#' \item{}{\code{centromereShape="triangle"}: Character scalar. The shape of |
|
709 |
+#' \item{\code{centromereShape="triangle"}:}{ Character scalar. The shape of |
|
710 | 710 |
#' the centromere. Only "triangle" or "circle" is accepted. Default to |
711 | 711 |
#' "triangle"} |
712 | 712 |
#' |
713 |
-#' \item{}{\code{cex.bands=0.7}: Numeric scalar. The font expansion factor for |
|
713 |
+#' \item{\code{cex.bands=0.7}:}{ Numeric scalar. The font expansion factor for |
|
714 | 714 |
#' the chromosome band identifier text.} |
715 | 715 |
#' |
716 |
-#' \item{}{\code{cex=0.8}: Numeric scalar. The overall font expansion factor |
|
716 |
+#' \item{\code{cex=0.8}:}{ Numeric scalar. The overall font expansion factor |
|
717 | 717 |
#' for the chromosome name text.} |
718 | 718 |
#' |
719 |
-#' \item{}{\code{col="red"}: Character scalar. The border color used for the |
|
719 |
+#' \item{\code{col="red"}:}{ Character scalar. The border color used for the |
|
720 | 720 |
#' highlighting of the currently displayed genomic region.} |
721 | 721 |
#' |
722 |
-#' \item{}{\code{col.border.title="transparent"}: Integer or character scalar. |
|
722 |
+#' \item{\code{col.border.title="transparent"}:}{ Integer or character scalar. |
|
723 | 723 |
#' The border color for the title panels.} |
724 | 724 |
#' |
725 |
-#' \item{}{\code{lwd.border.title=1}: Integer scalar. The border width for the |
|
725 |
+#' \item{\code{lwd.border.title=1}:}{ Integer scalar. The border width for the |
|
726 | 726 |
#' title panels.} |
727 | 727 |
#' |
728 |
-#' \item{}{\code{fill="#FFE3E6"}: Character scalar. The fill color used for the |
|
728 |
+#' \item{\code{fill="#FFE3E6"}:}{ Character scalar. The fill color used for the |
|
729 | 729 |
#' highlighting of the currently displayed genomic region.} |
730 | 730 |
#' |
731 |
-#' \item{}{\code{fontface=1}: Character scalar. The font face for the |
|
731 |
+#' \item{\code{fontface=1}:}{ Character scalar. The font face for the |
|
732 | 732 |
#' chromosome name text.} |
733 | 733 |
#' |
734 |
-#' \item{}{\code{fontfamily="sans"}: Character scalar. The font family for the |
|
734 |
+#' \item{\code{fontfamily="sans"}:}{ Character scalar. The font family for the |
|
735 | 735 |
#' chromosome name text.} |
736 | 736 |
#' |
737 |
-#' \item{}{\code{fontcolor="#808080"}: Character scalar. The font color for the |
|
737 |
+#' \item{\code{fontcolor="#808080"}:}{ Character scalar. The font color for the |
|
738 | 738 |
#' chromosome name text.} |
739 | 739 |
#' |
740 |
-#' \item{}{\code{fontsize=10}: Numeric scalar. The font size for the chromosome |
|
740 |
+#' \item{\code{fontsize=10}:}{ Numeric scalar. The font size for the chromosome |
|
741 | 741 |
#' name text.} |
742 | 742 |
#' |
743 |
-#' \item{}{\code{outline=FALSE}: Logical scalar. Add borders to the individual |
|
743 |
+#' \item{\code{outline=FALSE}:}{ Logical scalar. Add borders to the individual |
|
744 | 744 |
#' chromosome staining bands.} |
745 | 745 |
#' |
746 |
-#' \item{}{\code{showBandId=FALSE}: Logical scalar. Show the identifier for the |
|
746 |
+#' \item{\code{showBandId=FALSE}:}{ Logical scalar. Show the identifier for the |
|
747 | 747 |
#' chromosome bands if there is space for it.} |
748 | 748 |
#' |
749 |
-#' \item{}{\code{lty=1}: Character or integer scalar. The line type used for |
|
749 |
+#' \item{\code{lty=1}:}{ Character or integer scalar. The line type used for |
|
750 | 750 |
#' the highlighting of the currently displayed genomic region.} |
751 | 751 |
#' |
752 |
-#' \item{}{\code{lwd=1}: Numeric scalar. The line width used for the |
|
752 |
+#' \item{\code{lwd=1}:}{ Numeric scalar. The line width used for the |
|
753 | 753 |
#' highlighting of the currently displayed genomic region.} |
754 | 754 |
#' |
755 |
-#' \item{}{\code{showId=TRUE}: Logical scalar. Indicate the chromosome name |
|
755 |
+#' \item{\code{showId=TRUE}:}{ Logical scalar. Indicate the chromosome name |
|
756 | 756 |
#' next to the ideogram.} |
757 | 757 |
#' |
758 |
-#' \item{}{\code{showTitle=FALSE}: Logical scalar. Plot a title panel. Defaults |
|
758 |
+#' \item{\code{showTitle=FALSE}:}{ Logical scalar. Plot a title panel. Defaults |
|
759 | 759 |
#' to omit the title panel.} |
760 | 760 |
#' |
761 |
-#' \item{}{\code{size=NULL}: Numeric scalar. The relative size of the track. |
|
761 |
+#' \item{\code{size=NULL}:}{ Numeric scalar. The relative size of the track. |
|
762 | 762 |
#' Defaults to automatic size setting. Can also be overridden in the |
763 | 763 |
#' \code{\link{plotTracks}} function.} |
764 | 764 |
#' |
... | ... |
@@ -768,220 +768,220 @@ |
768 | 768 |
#' |
769 | 769 |
#' \describe{ |
770 | 770 |
#' |
771 |
-#' \item{}{\code{alpha=1}: Numeric scalar. The transparency for all track |
|
771 |
+#' \item{\code{alpha=1}:}{ Numeric scalar. The transparency for all track |
|
772 | 772 |
#' items.} |
773 | 773 |
#' |
774 |
-#' \item{}{\code{alpha.title=NULL}: Numeric scalar. The transparency for the |
|
774 |
+#' \item{\code{alpha.title=NULL}:}{ Numeric scalar. The transparency for the |
|
775 | 775 |
#' title panel.} |
776 | 776 |
#' |
777 |
-#' \item{}{\code{background.panel="transparent"}: Integer or character scalar. |
|
777 |
+#' \item{\code{background.panel="transparent"}:}{ Integer or character scalar. |
|
778 | 778 |
#' The background color of the content panel.} |
779 | 779 |
#' |
780 |
-#' \item{}{\code{background.legend="transparent"}: Integer or character scalar. |
|
780 |
+#' \item{\code{background.legend="transparent"}:}{ Integer or character scalar. |
|
781 | 781 |
#' The background color for the legend.} |
782 | 782 |
#' |
783 |
-#' \item{}{\code{cex.axis=NULL}: Numeric scalar. The expansion factor for the |
|
783 |
+#' \item{\code{cex.axis=NULL}:}{ Numeric scalar. The expansion factor for the |
|
784 | 784 |
#' axis annotation. Defaults to \code{NULL}, in which case it is automatically |
785 | 785 |
#' determined based on the available space.} |
786 | 786 |
#' |
787 |
-#' \item{}{\code{cex.title=NULL}: Numeric scalar. The expansion factor for the |
|
787 |
+#' \item{\code{cex.title=NULL}:}{ Numeric scalar. The expansion factor for the |
|
788 | 788 |
#' title panel. This effects the fontsize of both the title and the axis, if |
789 | 789 |
#' any. Defaults to \code{NULL}, which means that the text size is |
790 | 790 |
#' automatically adjusted to the available space.} |
791 | 791 |
#' |
792 |
-#' \item{}{\code{col.axis="white"}: Integer or character scalar. The font and |
|
792 |
+#' \item{\code{col.axis="white"}:}{ Integer or character scalar. The font and |
|
793 | 793 |
#' line color for the y axis, if any.} |
794 | 794 |
#' |
795 |
-#' \item{}{\code{col.frame="lightgray"}: Integer or character scalar. The line |
|
795 |
+#' \item{\code{col.frame="lightgray"}:}{ Integer or character scalar. The line |
|
796 | 796 |
#' color used for the panel frame, if \code{frame==TRUE}} |
797 | 797 |
#' |
798 |
-#' \item{}{\code{col.grid="#808080"}: Integer or character scalar. Default |
|
798 |
+#' \item{\code{col.grid="#808080"}:}{ Integer or character scalar. Default |
|
799 | 799 |
#' line color for grid lines, both when \code{type=="g"} in |
800 | 800 |
#' \code{\linkS4class{DataTrack}}s and when display parameter \code{grid==TRUE}.} |
801 | 801 |
#' |
802 |
-#' \item{}{\code{col.line=NULL}: Integer or character scalar. Default colors |
|
802 |
+#' \item{\code{col.line=NULL}:}{ Integer or character scalar. Default colors |
|
803 | 803 |
#' for plot lines. Usually the same as the global \code{col} parameter.} |
804 | 804 |
#' |
805 |
-#' \item{}{\code{col.symbol=NULL}: Integer or character scalar. Default colors |
|
805 |
+#' \item{\code{col.symbol=NULL}:}{ Integer or character scalar. Default colors |
|
806 | 806 |
#' for plot symbols. Usually the same as the global \code{col} parameter.} |
807 | 807 |
#' |
808 |
-#' \item{}{\code{col.title="white"}: Integer or character scalar. The border |
|
808 |
+#' \item{\code{col.title="white"}:}{ Integer or character scalar. The border |
|
809 | 809 |
#' color for the title panels} |
810 | 810 |
#' |
811 |
-#' \item{}{\code{collapse=TRUE}: Boolean controlling whether to collapse the |
|
811 |
+#' \item{\code{collapse=TRUE}:}{ Boolean controlling whether to collapse the |
|
812 | 812 |
#' content of the track to accomodate the minimum current device resolution. |
813 | 813 |
#' See \code{\link{collapsing}} for details.} |
814 | 814 |
#' |
815 |
-#' \item{}{\code{fontface.title=2}: Integer or character scalar. The font face |
|
815 |
+#' \item{\code{fontface.title=2}:}{ Integer or character scalar. The font face |
|
816 | 816 |
#' for the title panels.} |
817 | 817 |
#' |
818 |
-#' \item{}{\code{fontfamily.title="sans"}: Integer or character scalar. The |
|
818 |
+#' \item{\code{fontfamily.title="sans"}:}{ Integer or character scalar. The |
|
819 | 819 |
#' font family for the title panels.} |
820 | 820 |
#' |
821 |
-#' \item{}{\code{frame=FALSE}: Boolean. Draw a frame around the track when |
|
821 |
+#' \item{\code{frame=FALSE}:}{ Boolean. Draw a frame around the track when |
|
822 | 822 |
#' plotting.} |
823 | 823 |
#' |
824 |
-#' \item{}{\code{grid=FALSE}: Boolean, switching on/off the plotting of a |
|
824 |
+#' \item{\code{grid=FALSE}:}{ Boolean, switching on/off the plotting of a |
|
825 | 825 |
#' grid.} |
826 | 826 |
#' |
827 |
-#' \item{}{\code{h=-1}: Integer scalar. Parameter controlling the number of |
|
827 |
+#' \item{\code{h=-1}:}{ Integer scalar. Parameter controlling the number of |
|
828 | 828 |
#' horizontal grid lines, see \code{\link{panel.grid}} for details.} |
829 | 829 |
#' |
830 |
-#' \item{}{\code{lineheight=1}: Numeric scalar. The font line height for all |
|
830 |
+#' \item{\code{lineheight=1}:}{ Numeric scalar. The font line height for all |
|
831 | 831 |
#' text, unless a more specific definition exists.} |
832 | 832 |
#' |
833 |
-#' \item{}{\code{lty.grid="solid"}: Integer or character scalar. Default line |
|
833 |
+#' \item{\code{lty.grid="solid"}:}{ Integer or character scalar. Default line |
|
834 | 834 |
#' type for grid lines, both when \code{type=="g"} in \code{\linkS4class{DataTrack}}s |
835 | 835 |
#' and when display parameter \code{grid==TRUE}.} |
836 | 836 |
#' |
837 |
-#' \item{}{\code{lwd.title=1}: Integer scalar. The border width for the title |
|
837 |
+#' \item{\code{lwd.title=1}:}{ Integer scalar. The border width for the title |
|
838 | 838 |
#' panels} |
839 | 839 |
#' |
840 |
-#' \item{}{\code{lwd.grid=1}: Numeric scalar. Default line width for grid |
|
840 |
+#' \item{\code{lwd.grid=1}:}{ Numeric scalar. Default line width for grid |
|
841 | 841 |
#' lines, both when \code{type=="g"} in \code{\linkS4class{DataTrack}}s and when |
842 | 842 |
#' display parameter \code{grid==TRUE}.} |
843 | 843 |
#' |
844 |
-#' \item{}{\code{min.distance=1}: Numeric scalar. The minimum pixel distance |
|
844 |
+#' \item{\code{min.distance=1}:}{ Numeric scalar. The minimum pixel distance |
|
845 | 845 |
#' before collapsing range items, only if \code{collapse==TRUE}. See |
846 | 846 |
#' \code{\link{collapsing}} for details.} |
847 | 847 |
#' |
848 |
-#' \item{}{\code{min.height=3}: Numeric scalar. The minimum range height in |
|
848 |
+#' \item{\code{min.height=3}:}{ Numeric scalar. The minimum range height in |
|
849 | 849 |
#' pixels to display. All ranges are expanded to this size in order to avoid |
850 | 850 |
#' rendering issues. See \code{\link{collapsing}} for details.} |
851 | 851 |
#' |
852 |
-#' \item{}{\code{min.width=1}: Numeric scalar. The minimum range width in |
|
852 |
+#' \item{\code{min.width=1}:}{ Numeric scalar. The minimum range width in |
|
853 | 853 |
#' pixels to display. All ranges are expanded to this size in order to avoid |
854 | 854 |
#' rendering issues. See \code{\link{collapsing}} for details.} |
855 | 855 |
#' |
856 |
-#' \item{}{\code{reverseStrand=FALSE}: Logical scalar. Set up the plotting |
|
856 |
+#' \item{\code{reverseStrand=FALSE}:}{ Logical scalar. Set up the plotting |
|
857 | 857 |
#' coordinates in 3' -> 5' direction if \code{TRUE}. This will effectively |
858 | 858 |
#' mirror the plot on the vertical axis.} |
859 | 859 |
#' |
860 |
-#' \item{}{\code{rotation.title=90}: The rotation angle for the text in the |
|
860 |
+#' \item{\code{rotation.title=90}:}{ The rotation angle for the text in the |
|
861 | 861 |
#' title panel. Even though this can be adjusted, the automatic resizing of the |
862 | 862 |
#' title panel will currently not work, so use at own risk.} |
863 | 863 |
#' |
864 |
-#' \item{}{\code{rotation=0}: The rotation angle for all text unless a more |
|
864 |
+#' \item{\code{rotation=0}:}{ The rotation angle for all text unless a more |
|
865 | 865 |
#' specific definiton exists.} |
866 | 866 |
#' |
867 |
-#' \item{}{\code{showAxis=TRUE}: Boolean controlling whether to plot a y axis |
|
867 |
+#' \item{\code{showAxis=TRUE}:}{ Boolean controlling whether to plot a y axis |
|
868 | 868 |
#' (only applies to track types where axes are implemented).} |
869 | 869 |
#' |
870 |
-#' \item{}{\code{v=-1}: Integer scalar. Parameter controlling the number of |
|
870 |
+#' \item{\code{v=-1}:}{ Integer scalar. Parameter controlling the number of |
|
871 | 871 |
#' vertical grid lines, see \code{\link{panel.grid}} for details.} |
872 | 872 |
#' |
873 | 873 |
#' } |
874 | 874 |
#' |
875 | 875 |
#' } |
876 | 876 |
#' |
877 |
-#' \item{AnnotationTrack}{: |
|
877 |
+#' \item{AnnotationTrack:}{ |
|
878 | 878 |
#' |
879 | 879 |
#' \describe{ |
880 | 880 |
#' |
881 |
-#' \item{}{\code{arrowHeadWidth=30}: Numeric scalar. The width of the arrow |
|
881 |
+#' \item{\code{arrowHeadWidth=30}:}{ Numeric scalar. The width of the arrow |
|
882 | 882 |
#' head in pixels if \code{shape} is \code{fixedArrow}.} |
883 | 883 |
#' |
884 |
-#' \item{}{\code{arrowHeadMaxWidth=40}: Numeric scalar. The maximum width of |
|
884 |
+#' \item{\code{arrowHeadMaxWidth=40}:}{ Numeric scalar. The maximum width of |
|
885 | 885 |
#' the arrow head in pixels if \code{shape} is \code{arrow}.} |
886 | 886 |
#' |
887 |
-#' \item{}{\code{cex.group=0.6}: Numeric scalar. The font expansion factor for |
|
887 |
+#' \item{\code{cex.group=0.6}:}{ Numeric scalar. The font expansion factor for |
|
888 | 888 |
#' the group-level annotation.} |
889 | 889 |
#' |
890 |
-#' \item{}{\code{cex=1}: Numeric scalar. The font expansion factor for item |
|
890 |
+#' \item{\code{cex=1}:}{ Numeric scalar. The font expansion factor for item |
|
891 | 891 |
#' identifiers.} |
892 | 892 |
#' |
893 |
-#' \item{}{\code{col.line="darkgray"}: Character scalar. The color used for |
|
893 |
+#' \item{\code{col.line="darkgray"}:}{ Character scalar. The color used for |
|
894 | 894 |
#' connecting lines between grouped items. Defaults to a light gray, but if set |
895 | 895 |
#' to \code{NULL} the same color as for the first item in the group is used.} |
896 | 896 |
#' |
897 |
-#' \item{}{\code{col="transparent"}: Character or integer scalar. The border |
|
897 |
+#' \item{\code{col="transparent"}:}{ Character or integer scalar. The border |
|
898 | 898 |
#' color for all track items.} |
899 | 899 |
#' |
900 |
-#' \item{}{\code{featureAnnotation=NULL}: Character scalar. Add annotation |
|
900 |
+#' \item{\code{featureAnnotation=NULL}:}{ Character scalar. Add annotation |
|
901 | 901 |
#' information to the individual track elements. This can be a value in |
902 | 902 |
#' \code{id}, \code{group} or \code{feature}. Defaults to \code{id}. Only |
903 | 903 |
#' works if \code{showFeatureId} is not \code{FALSE}.} |
904 | 904 |
#' |
905 |
-#' \item{}{\code{fill="lightblue"}: Character or integer scalar. The fill |
|
905 |
+#' \item{\code{fill="lightblue"}:}{ Character or integer scalar. The fill |
|
906 | 906 |
#' color for untyped items. This is also used to connect grouped items. See |
907 | 907 |
#' \code{\link{grouping}} for details.} |
908 | 908 |
#' |
909 |
-#' \item{}{\code{fontfamily.group="sans"}: Character scalar. The font family |
|
909 |
+#' \item{\code{fontfamily.group="sans"}:}{ Character scalar. The font family |
|
910 | 910 |
#' for the group-level annotation.} |
911 | 911 |
#' |
912 |
-#' \item{}{\code{fontcolor.group="#808080"}: Character or integer scalar. The |
|
912 |
+#' \item{\code{fontcolor.group="#808080"}:}{ Character or integer scalar. The |
|
913 | 913 |
#' font color for the group-level annotation.} |
914 | 914 |
#' |
915 |
-#' \item{}{\code{fontcolor.item="white"}: Character or integer scalar. The font |
|
915 |
+#' \item{\code{fontcolor.item="white"}:}{ Character or integer scalar. The font |
|
916 | 916 |
#' color for item identifiers.} |
917 | 917 |
#' |
918 |
-#' \item{}{\code{fontface.group=2}: Numeric scalar. The font face for the |
|
918 |
+#' \item{\code{fontface.group=2}:}{ Numeric scalar. The font face for the |
|
919 | 919 |
#' group-level annotation.} |
920 | 920 |
#' |
921 |
-#' \item{}{\code{fontsize.group=12}: Numeric scalar. The font size for the |
|
921 |
+#' \item{\code{fontsize.group=12}:}{ Numeric scalar. The font size for the |
|
922 | 922 |
#' group-level annotation.} |
923 | 923 |
#' |
924 |
-#' \item{}{\code{groupAnnotation=NULL}: Character scalar. Add annotation |
|
924 |
+#' \item{\code{groupAnnotation=NULL}:}{ Character scalar. Add annotation |
|
925 | 925 |
#' information as group labels. This can be a value in \code{id}, \code{group} |
926 | 926 |
#' or \code{feature}. Defaults to \code{group}. Only works if \code{showId} is |
927 | 927 |
#' not \code{FALSE}.} |
928 | 928 |
#' |
929 |
-#' \item{}{\code{just.group="left"}: Character scalar. the justification of |
|
929 |
+#' \item{\code{just.group="left"}:}{ Character scalar. the justification of |
|
930 | 930 |
#' group labels. Either \code{left}, \code{right}, \code{above} or |
931 | 931 |
#' \code{below}.} |
932 | 932 |
#' |
933 |
-#' \item{}{\code{lex=1}: Numeric scalar. The line expansion factor for all |
|
933 |
+#' \item{\code{lex=1}:}{ Numeric scalar. The line expansion factor for all |
|
934 | 934 |
#' track items. This is also used to connect grouped items. See |
935 | 935 |
#' \code{\link{grouping}} for details.} |
936 | 936 |
#' |
937 |
-#' \item{}{\code{lineheight=1}: Numeric scalar. The font line height for item |
|
937 |
+#' \item{\code{lineheight=1}:}{ Numeric scalar. The font line height for item |
|
938 | 938 |
#' identifiers.} |
939 | 939 |
#' |
940 |
-#' \item{}{\code{lty="solid"}: Character or integer scalar. The line type for |
|
940 |
+#' \item{\code{lty="solid"}:}{ Character or integer scalar. The line type for |
|
941 | 941 |
#' all track items. This is also used to connect grouped items. See |
942 | 942 |
#' \code{\link{grouping}} for details.} |
943 | 943 |
#' |
944 |
-#' \item{}{\code{lwd=1}: Integer scalar. The line width for all track items. |
|
944 |
+#' \item{\code{lwd=1}:}{ Integer scalar. The line width for all track items. |
|
945 | 945 |
#' This is also used to connect grouped items. See \code{\link{grouping}} for |
946 | 946 |
#' details.} |
947 | 947 |
#' |
948 |
-#' \item{}{\code{mergeGroups=FALSE}: Logical scalar. Merge fully overlapping |
|
948 |
+#' \item{\code{mergeGroups=FALSE}:}{ Logical scalar. Merge fully overlapping |
|
949 | 949 |
#' groups if \code{collapse==TRUE}.} |
950 | 950 |
#' |
951 |
-#' \item{}{\code{min.height=3}: Numeric scalar. The minimum range height in |
|
951 |
+#' \item{\code{min.height=3}:}{ Numeric scalar. The minimum range height in |
|
952 | 952 |
#' pixels to display. All ranges are expanded to this size in order to avoid |
953 | 953 |
#' rendering issues. See \code{\link{collapsing}} for details. For feathered |
954 | 954 |
#' bars indicating the strandedness of grouped items this also controls the |
955 | 955 |
#' height of the arrow feathers.} |
956 | 956 |
#' |
957 |
-#' \item{}{\code{min.width=1}: Numeric scalar. The minimum range width in |
|
957 |
+#' \item{\code{min.width=1}:}{ Numeric scalar. The minimum range width in |
|
958 | 958 |
#' pixels to display. All ranges are expanded to this size in order to avoid |
959 | 959 |
#' rendering issues. See \code{\link{collapsing}} for details.} |
960 | 960 |
#' |
961 |
-#' \item{}{\code{rotation=0}: Numeric scalar. The degree of text rotation for |
|
961 |
+#' \item{\code{rotation=0}:}{ Numeric scalar. The degree of text rotation for |
|
962 | 962 |
#' item identifiers.} |
963 | 963 |
#' |
964 |
-#' \item{}{\code{rotation.group=0}: Numeric scalar. The degree of text rotation |
|
964 |
+#' \item{\code{rotation.group=0}:}{ Numeric scalar. The degree of text rotation |
|
965 | 965 |
#' for group labels.} |
966 | 966 |
#' |
967 |
-#' \item{}{\code{rotation.item=0}: Numeric scalar. The degree of text rotation |
|
967 |
+#' \item{\code{rotation.item=0}:}{ Numeric scalar. The degree of text rotation |
|
968 | 968 |
#' for item identifiers.} |