1. ComplexHeatmap
  2. man
  3. column_order-HeatmapList-method.rd
Browse code

generate documentations by pkgdown

Zuguang Gu authored on 18/10/2019 11:34:02
Showing1 changed files
man/column_order-HeatmapList-method.rd
History View file @1cb7fea
1 1 
deleted file mode 100644
... ... 
@@ -1,38 +0,0 @@
1 
-\name{column_order-HeatmapList-method}
2 
-\alias{column_order,HeatmapList-method}
3 
-\title{
4 
-Get Column Order from a Heatmap List
5 
-}
6 
-\description{
7 
-Get Column Order from a Heatmap List
8 
-}
9 
-\usage{
10 
-\S4method{column_order}{HeatmapList}(object, name = NULL)
11 
-}
12 
-\arguments{
13 
-
14 
-  \item{object}{A \code{\link{HeatmapList-class}} object.}
15 
-  \item{name}{Name of a specific heatmap.}
16 
-
17 
-}
18 
-\value{
19 
-The format of the returned object depends on whether rows/columns of the heatmaps are split.
20 
-}
21 
-\author{
22 
-Zuguang Gu <z.gu@dkfz.de>
23 
-}
24 
-\examples{
25 
-mat = matrix(rnorm(100), 10)
26 
-ht_list = Heatmap(mat) + Heatmap(mat)
27 
-ht_list = draw(ht_list)
28 
-column_order(ht_list)
29 
-ht_list = Heatmap(mat, column_km = 2) + Heatmap(mat, column_km = 2)
30 
-ht_list = draw(ht_list)
31 
-column_order(ht_list)
32 
-ht_list = Heatmap(mat) \%v\% Heatmap(mat)
33 
-ht_list = draw(ht_list)
34 
-column_order(ht_list)
35 
-ht_list = Heatmap(mat, column_km = 2) \%v\% Heatmap(mat)
36 
-ht_list = draw(ht_list)
37 
-column_order(ht_list)
38 
-}
Browse code

documentation checked

Zuguang Gu authored on 23/10/2018 19:59:12
Showing1 changed files
man/column_order-HeatmapList-method.rd
History View file @3c40a7c
... ... 
@@ -1,17 +1,18 @@
1 1 
 \name{column_order-HeatmapList-method}
2 2 
 \alias{column_order,HeatmapList-method}
3 3 
 \title{
4 
-Get column order from a heatmap list
4 
+Get Column Order from a Heatmap List
5 5 
 }
6 6 
 \description{
7 
-Get column order from a heatmap list
7 
+Get Column Order from a Heatmap List
8 8 
 }
9 9 
 \usage{
10 
-\S4method{column_order}{HeatmapList}(object)
10 
+\S4method{column_order}{HeatmapList}(object, name = NULL)
11 11 
 }
12 12 
 \arguments{
13 13
14 
-  \item{object}{a \code{\link{HeatmapList-class}} object}
14 
+  \item{object}{A \code{\link{HeatmapList-class}} object.}
15 
+  \item{name}{Name of a specific heatmap.}
15 16
16 17 
 }
17 18 
 \value{
... ... 
@@ -28,10 +29,10 @@ column_order(ht_list)
28 29 
 ht_list = Heatmap(mat, column_km = 2) + Heatmap(mat, column_km = 2)
29 30 
 ht_list = draw(ht_list)
30 31 
 column_order(ht_list)
31 
-ht_list = Heatmap(mat) %v% Heatmap(mat)
32 
+ht_list = Heatmap(mat) \%v\% Heatmap(mat)
32 33 
 ht_list = draw(ht_list)
33 34 
 column_order(ht_list)
34 
-ht_list = Heatmap(mat, column_km = 2) %v% Heatmap(mat)
35 
+ht_list = Heatmap(mat, column_km = 2) \%v\% Heatmap(mat)
35 36 
 ht_list = draw(ht_list)
36 37 
 column_order(ht_list)
37 38 
 }
Browse code

update

jokergoo authored on 12/10/2018 15:28:37
Showing1 changed files
man/column_order-HeatmapList-method.rd
History View file @1a56796
... ... 
@@ -15,7 +15,7 @@ Get column order from a heatmap list
15 15
16 16 
 }
17 17 
 \value{
18 
-A list contains column orders which correspond every matrix
18 
+The format of the returned object depends on whether rows/columns of the heatmaps are split.
19 19 
 }
20 20 
 \author{
21 21 
 Zuguang Gu <z.gu@dkfz.de>
... ... 
@@ -23,11 +23,15 @@ Zuguang Gu <z.gu@dkfz.de>
23 23 
 \examples{
24 24 
 mat = matrix(rnorm(100), 10)
25 25 
 ht_list = Heatmap(mat) + Heatmap(mat)
26 
+ht_list = draw(ht_list)
26 27 
 column_order(ht_list)
27 28 
 ht_list = Heatmap(mat, column_km = 2) + Heatmap(mat, column_km = 2)
29 
+ht_list = draw(ht_list)
28 30 
 column_order(ht_list)
29 31 
 ht_list = Heatmap(mat) %v% Heatmap(mat)
32 
+ht_list = draw(ht_list)
30 33 
 column_order(ht_list)
31 34 
 ht_list = Heatmap(mat, column_km = 2) %v% Heatmap(mat)
35 
+ht_list = draw(ht_list)
32 36 
 column_order(ht_list)
33 37 
 }
Browse code

R CMD check passed

Zuguang Gu authored on 20/09/2018 12:48:08
Showing1 changed files
man/column_order-HeatmapList-method.rd
History View file @ad35494
1 1 
old mode 100755
2 2 
new mode 100644
... ... 
@@ -24,6 +24,10 @@ Zuguang Gu <z.gu@dkfz.de>
24 24 
 mat = matrix(rnorm(100), 10)
25 25 
 ht_list = Heatmap(mat) + Heatmap(mat)
26 26 
 column_order(ht_list)
27 
-ht = Heatmap(mat, km = 2) + Heatmap(mat)
27 
+ht_list = Heatmap(mat, column_km = 2) + Heatmap(mat, column_km = 2)
28 
+column_order(ht_list)
29 
+ht_list = Heatmap(mat) %v% Heatmap(mat)
30 
+column_order(ht_list)
31 
+ht_list = Heatmap(mat, column_km = 2) %v% Heatmap(mat)
28 32 
 column_order(ht_list)
29 33 
 }
Browse code

anoying rebase

git-svn-id: https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/ComplexHeatmap@111684 bc3139a8-67e5-0310-9ffc-ced21a209358

z.gu authored on 20/12/2015 21:42:51
Showing1 changed files
man/column_order-HeatmapList-method.rd
History View file @793b75d
... ... 
@@ -17,8 +17,13 @@ Get column order from a heatmap list
17 17 
 \value{
18 18 
 A list contains column orders which correspond every matrix
19 19 
 }
20 
+\author{
21 
+Zuguang Gu <z.gu@dkfz.de>
22 
+}
20 23 
 \examples{
21 
-# There is no example
22 
-NULL
23 
-
24 
+mat = matrix(rnorm(100), 10)
25 
+ht_list = Heatmap(mat) + Heatmap(mat)
26 
+column_order(ht_list)
27 
+ht = Heatmap(mat, km = 2) + Heatmap(mat)
28 
+column_order(ht_list)
24 29 
 }
Browse code

Merge branch 'master' into devel

git-svn-id: https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/ComplexHeatmap@108253 bc3139a8-67e5-0310-9ffc-ced21a209358

z.gu authored on 07/09/2015 20:39:32
Showing1 changed files
man/column_order-HeatmapList-method.rd
History View file @8e55abf
1 1 
old mode 100644
2 2 
new mode 100755
Browse code

resolve conflict from master branch

git-svn-id: https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/ComplexHeatmap@108131 bc3139a8-67e5-0310-9ffc-ced21a209358

z.gu authored on 03/09/2015 20:32:44
Showing1 changed files
man/column_order-HeatmapList-method.rd
History View file @12e8549
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,24 @@
1 
+\name{column_order-HeatmapList-method}
2 
+\alias{column_order,HeatmapList-method}
3 
+\title{
4 
+Get column order from a heatmap list
5 
+}
6 
+\description{
7 
+Get column order from a heatmap list
8 
+}
9 
+\usage{
10 
+\S4method{column_order}{HeatmapList}(object)
11 
+}
12 
+\arguments{
13 
+
14 
+  \item{object}{a \code{\link{HeatmapList-class}} object}
15 
+
16 
+}
17 
+\value{
18 
+A list contains column orders which correspond every matrix
19 
+}
20 
+\examples{
21 
+# There is no example
22 
+NULL
23 
+
24 
+}