Browse code

generate documentations by pkgdown

Zuguang Gu authored on 18/10/2019 11:34:02
Showing1 changed files
1 1
deleted file mode 100644
... ...
@@ -1,41 +0,0 @@
1
-\name{draw_dend-Heatmap-method}
2
-\alias{draw_dend,Heatmap-method}
3
-\alias{draw_dend}
4
-\title{
5
-Draw Heatmap Dendrograms
6
-}
7
-\description{
8
-Draw Heatmap Dendrograms
9
-}
10
-\usage{
11
-\S4method{draw_dend}{Heatmap}(object,
12
-    which = c("row", "column"), k = 1, max_height = NULL, ...)
13
-}
14
-\arguments{
15
-
16
-  \item{object}{A \code{\link{Heatmap-class}} object.}
17
-  \item{which}{Are the dendrograms put on the row or on the column of the heatmap?}
18
-  \item{k}{Slice index.}
19
-  \item{max_height}{maximal height of dendrogram.}
20
-  \item{...}{Pass to \code{\link[grid]{viewport}} which includes the complete heatmap dendrograms.}
21
-
22
-}
23
-\details{
24
-A viewport is created which contains dendrograms.
25
-
26
-This function is only for internal use.
27
-}
28
-\value{
29
-This function returns no value.
30
-}
31
-\seealso{
32
-\code{\link{grid.dendrogram}}
33
-}
34
-\author{
35
-Zuguang Gu <z.gu@dkfz.de>
36
-}
37
-\examples{
38
-# There is no example
39
-NULL
40
-
41
-}
Browse code

add jitter argument to Heatmap()

Zuguang Gu authored on 28/09/2019 08:37:13
Showing1 changed files
... ...
@@ -1,5 +1,6 @@
1 1
 \name{draw_dend-Heatmap-method}
2 2
 \alias{draw_dend,Heatmap-method}
3
+\alias{draw_dend}
3 4
 \title{
4 5
 Draw Heatmap Dendrograms
5 6
 }
... ...
@@ -33,8 +34,8 @@ This function returns no value.
33 34
 \author{
34 35
 Zuguang Gu <z.gu@dkfz.de>
35 36
 }
36
-\alias{draw_dend}
37 37
 \examples{
38 38
 # There is no example
39 39
 NULL
40
+
40 41
 }
Browse code

use pkgdown to build the doc site

Zuguang Gu authored on 24/09/2019 21:01:04
Showing1 changed files
... ...
@@ -1,6 +1,5 @@
1 1
 \name{draw_dend-Heatmap-method}
2 2
 \alias{draw_dend,Heatmap-method}
3
-\alias{draw_dend}
4 3
 \title{
5 4
 Draw Heatmap Dendrograms
6 5
 }
... ...
@@ -34,8 +33,8 @@ This function returns no value.
34 33
 \author{
35 34
 Zuguang Gu <z.gu@dkfz.de>
36 35
 }
36
+\alias{draw_dend}
37 37
 \examples{
38 38
 # There is no example
39 39
 NULL
40
-
41 40
 }
Browse code

set cluster_slice to FALSE for character matrix

Zuguang Gu authored on 18/01/2019 10:43:26
Showing1 changed files
... ...
@@ -1,5 +1,6 @@
1 1
 \name{draw_dend-Heatmap-method}
2 2
 \alias{draw_dend,Heatmap-method}
3
+\alias{draw_dend}
3 4
 \title{
4 5
 Draw Heatmap Dendrograms
5 6
 }
... ...
@@ -33,8 +34,8 @@ This function returns no value.
33 34
 \author{
34 35
 Zuguang Gu <z.gu@dkfz.de>
35 36
 }
36
-\alias{draw_dend}
37 37
 \examples{
38 38
 # There is no example
39 39
 NULL
40
+
40 41
 }
Browse code

add NEWs

Zuguang Gu authored on 30/12/2018 08:12:22
Showing1 changed files
... ...
@@ -1,6 +1,5 @@
1 1
 \name{draw_dend-Heatmap-method}
2 2
 \alias{draw_dend,Heatmap-method}
3
-\alias{draw_dend}
4 3
 \title{
5 4
 Draw Heatmap Dendrograms
6 5
 }
... ...
@@ -34,8 +33,8 @@ This function returns no value.
34 33
 \author{
35 34
 Zuguang Gu <z.gu@dkfz.de>
36 35
 }
36
+\alias{draw_dend}
37 37
 \examples{
38 38
 # There is no example
39 39
 NULL
40
-
41 40
 }
Browse code

fix some bugs

Zuguang Gu authored on 19/10/2018 19:08:59
Showing1 changed files
... ...
@@ -1,5 +1,6 @@
1 1
 \name{draw_dend-Heatmap-method}
2 2
 \alias{draw_dend,Heatmap-method}
3
+\alias{draw_dend}
3 4
 \title{
4 5
 Draw Heatmap Dendrograms
5 6
 }
... ...
@@ -33,8 +34,8 @@ This function returns no value.
33 34
 \author{
34 35
 Zuguang Gu <z.gu@dkfz.de>
35 36
 }
36
-\alias{draw_dend}
37 37
 \examples{
38 38
 # There is no example
39 39
 NULL
40
+
40 41
 }
Browse code

update

Zuguang Gu authored on 17/10/2018 06:09:36
Showing1 changed files
... ...
@@ -1,6 +1,5 @@
1 1
 \name{draw_dend-Heatmap-method}
2 2
 \alias{draw_dend,Heatmap-method}
3
-\alias{draw_dend}
4 3
 \title{
5 4
 Draw Heatmap Dendrograms
6 5
 }
... ...
@@ -34,8 +33,8 @@ This function returns no value.
34 33
 \author{
35 34
 Zuguang Gu <z.gu@dkfz.de>
36 35
 }
36
+\alias{draw_dend}
37 37
 \examples{
38 38
 # There is no example
39 39
 NULL
40
-
41 40
 }
Browse code

R CMD check passed

Zuguang Gu authored on 12/10/2018 19:19:48
Showing1 changed files
... ...
@@ -1,5 +1,6 @@
1 1
 \name{draw_dend-Heatmap-method}
2 2
 \alias{draw_dend,Heatmap-method}
3
+\alias{draw_dend}
3 4
 \title{
4 5
 Draw Heatmap Dendrograms
5 6
 }
... ...
@@ -33,8 +34,8 @@ This function returns no value.
33 34
 \author{
34 35
 Zuguang Gu <z.gu@dkfz.de>
35 36
 }
36
-\alias{draw_dend}
37 37
 \examples{
38 38
 # There is no example
39 39
 NULL
40
+
40 41
 }
Browse code

update

jokergoo authored on 12/10/2018 15:28:37
Showing1 changed files
... ...
@@ -1,6 +1,5 @@
1 1
 \name{draw_dend-Heatmap-method}
2 2
 \alias{draw_dend,Heatmap-method}
3
-\alias{draw_dend}
4 3
 \title{
5 4
 Draw Heatmap Dendrograms
6 5
 }
... ...
@@ -34,8 +33,8 @@ This function returns no value.
34 33
 \author{
35 34
 Zuguang Gu <z.gu@dkfz.de>
36 35
 }
36
+\alias{draw_dend}
37 37
 \examples{
38 38
 # There is no example
39 39
 NULL
40
-
41 40
 }
Browse code

vignette check passed

Zuguang Gu authored on 20/09/2018 22:09:48
Showing1 changed files
... ...
@@ -1,5 +1,6 @@
1 1
 \name{draw_dend-Heatmap-method}
2 2
 \alias{draw_dend,Heatmap-method}
3
+\alias{draw_dend}
3 4
 \title{
4 5
 Draw Heatmap Dendrograms
5 6
 }
... ...
@@ -33,8 +34,8 @@ This function returns no value.
33 34
 \author{
34 35
 Zuguang Gu <z.gu@dkfz.de>
35 36
 }
36
-\alias{draw_dend}
37 37
 \examples{
38 38
 # There is no example
39 39
 NULL
40
+
40 41
 }
Browse code

R CMD check passed

Zuguang Gu authored on 20/09/2018 12:48:08
Showing1 changed files
1 1
old mode 100755
2 2
new mode 100644
... ...
@@ -1,11 +1,10 @@
1 1
 \name{draw_dend-Heatmap-method}
2 2
 \alias{draw_dend,Heatmap-method}
3
-\alias{draw_dend}
4 3
 \title{
5
-Draw dendrogram on row or column
4
+Draw Heatmap Dendrograms
6 5
 }
7 6
 \description{
8
-Draw dendrogram on row or column
7
+Draw Heatmap Dendrograms
9 8
 }
10 9
 \usage{
11 10
 \S4method{draw_dend}{Heatmap}(object,
... ...
@@ -13,17 +12,14 @@ Draw dendrogram on row or column
13 12
 }
14 13
 \arguments{
15 14
 
16
-  \item{object}{a \code{\link{Heatmap-class}} object.}
17
-  \item{which}{is dendrogram put on the row or on the column of the heatmap?}
18
-  \item{k}{a matrix may be splitted by rows, the value identifies which row-slice.}
19
-  \item{max_height}{maximum height of the dendrograms.}
20
-  \item{...}{pass to \code{\link[grid]{viewport}}, basically for defining the position of the viewport.}
15
+  \item{object}{A \code{\link{Heatmap-class}} object.}
16
+  \item{which}{Are the dendrograms put on the row or on the column of the heatmap?}
17
+  \item{k}{Slice index.}
18
+  \item{max_height}{maximal height of dendrogram.}
19
+  \item{...}{Pass to \code{\link[grid]{viewport}} which includes the complete heatmap dendrograms.}
21 20
 
22 21
 }
23 22
 \details{
24
-If the matrix is split into several row slices, a list of dendrograms will be drawn by 
25
-the heatmap that each dendrogram corresponds to its row slices.
26
-
27 23
 A viewport is created which contains dendrograms.
28 24
 
29 25
 This function is only for internal use.
... ...
@@ -37,8 +33,8 @@ This function returns no value.
37 33
 \author{
38 34
 Zuguang Gu <z.gu@dkfz.de>
39 35
 }
36
+\alias{draw_dend}
40 37
 \examples{
41 38
 # There is no example
42 39
 NULL
43
-
44 40
 }
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
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
1 1
new file mode 100644
... ...
@@ -0,0 +1,44 @@
1
+\name{draw_dend-Heatmap-method}
2
+\alias{draw_dend,Heatmap-method}
3
+\alias{draw_dend}
4
+\title{
5
+Draw dendrogram on row or column
6
+}
7
+\description{
8
+Draw dendrogram on row or column
9
+}
10
+\usage{
11
+\S4method{draw_dend}{Heatmap}(object,
12
+    which = c("row", "column"), k = 1, max_height = NULL, ...)
13
+}
14
+\arguments{
15
+
16
+  \item{object}{a \code{\link{Heatmap-class}} object.}
17
+  \item{which}{is dendrogram put on the row or on the column of the heatmap?}
18
+  \item{k}{a matrix may be splitted by rows, the value identifies which row-slice.}
19
+  \item{max_height}{maximum height of the dendrograms.}
20
+  \item{...}{pass to \code{\link[grid]{viewport}}, basically for defining the position of the viewport.}
21
+
22
+}
23
+\details{
24
+If the matrix is split into several row slices, a list of dendrograms will be drawn by 
25
+the heatmap that each dendrogram corresponds to its row slices.
26
+
27
+A viewport is created which contains dendrograms.
28
+
29
+This function is only for internal use.
30
+}
31
+\value{
32
+This function returns no value.
33
+}
34
+\seealso{
35
+\code{\link{grid.dendrogram}}
36
+}
37
+\author{
38
+Zuguang Gu <z.gu@dkfz.de>
39
+}
40
+\examples{
41
+# There is no example
42
+NULL
43
+
44
+}