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,43 +0,0 @@
1
-\name{decorate_title}
2
-\alias{decorate_title}
3
-\title{
4
-Decorate Heatmap Titles
5
-}
6
-\description{
7
-Decorate Heatmap Titles
8
-}
9
-\usage{
10
-decorate_title(heatmap, code, slice = 1, which = c("column", "row"),
11
-    envir = new.env(parent = parent.frame()))
12
-}
13
-\arguments{
14
-
15
-  \item{heatmap}{Name of the heatmap.}
16
-  \item{code}{Code that adds graphics in the selected viewport.}
17
-  \item{slice}{Index of the row slice or column slice in the heatmap.}
18
-  \item{which}{Is it a row title or a column title?}
19
-  \item{envir}{Where to look for variables inside \code{code}.}
20
-
21
-}
22
-\details{
23
-There is a viewport for row titles and column title in the heatmap.
24
-This function contructs the name of the viewport,
25
-goes to the viewport by \code{\link[grid:viewports]{seekViewport}} , runs code
26
-to that viewport and finally goes back to the original viewport.
27
-}
28
-\value{
29
-The function returns no value.
30
-}
31
-\seealso{
32
-\url{https://jokergoo.github.io/ComplexHeatmap-reference/book/heatmap-decoration.html}
33
-}
34
-\author{
35
-Zuguang Gu <z.gu@dkfz.de>
36
-}
37
-\examples{
38
-set.seed(123)
39
-Heatmap(matrix(rnorm(100), 10), name = "mat", km = 2)
40
-decorate_title("mat", {
41
-    grid.rect(gp = gpar(fill = "#FF000080"))
42
-}, which = "row", slice = 2)
43
-}
Browse code

fix warnings in Rd files

Zuguang Gu authored on 28/11/2018 09:32:19
Showing1 changed files
... ...
@@ -22,7 +22,7 @@ decorate_title(heatmap, code, slice = 1, which = c("column", "row"),
22 22
 \details{
23 23
 There is a viewport for row titles and column title in the heatmap.
24 24
 This function contructs the name of the viewport,
25
-goes to the viewport by \code{\link[grid]{seekViewport}} , runs code
25
+goes to the viewport by \code{\link[grid:viewports]{seekViewport}} , runs code
26 26
 to that viewport and finally goes back to the original viewport.
27 27
 }
28 28
 \value{
Browse code

documentation checked

Zuguang Gu authored on 23/10/2018 19:59:12
Showing1 changed files
... ...
@@ -1,10 +1,10 @@
1 1
 \name{decorate_title}
2 2
 \alias{decorate_title}
3 3
 \title{
4
-Decorate the heatmap title
4
+Decorate Heatmap Titles
5 5
 }
6 6
 \description{
7
-Decorate the heatmap title
7
+Decorate Heatmap Titles
8 8
 }
9 9
 \usage{
10 10
 decorate_title(heatmap, code, slice = 1, which = c("column", "row"),
... ...
@@ -12,22 +12,25 @@ decorate_title(heatmap, code, slice = 1, which = c("column", "row"),
12 12
 }
13 13
 \arguments{
14 14
 
15
-  \item{heatmap}{name of the heatmap}
16
-  \item{code}{code that adds graphics in the selected heatmap body}
17
-  \item{slice}{index of row slice or column slice in the heatmap}
18
-  \item{which}{on rows or on columns?}
19
-  \item{envir}{where to look for variables inside \code{code}}
15
+  \item{heatmap}{Name of the heatmap.}
16
+  \item{code}{Code that adds graphics in the selected viewport.}
17
+  \item{slice}{Index of the row slice or column slice in the heatmap.}
18
+  \item{which}{Is it a row title or a column title?}
19
+  \item{envir}{Where to look for variables inside \code{code}.}
20 20
 
21 21
 }
22 22
 \details{
23 23
 There is a viewport for row titles and column title in the heatmap.
24 24
 This function contructs the name of the viewport,
25
-goes to the viewport by \code{\link[grid]{seekViewport}} and applies code
26
-to that viewport.
25
+goes to the viewport by \code{\link[grid]{seekViewport}} , runs code
26
+to that viewport and finally goes back to the original viewport.
27 27
 }
28 28
 \value{
29 29
 The function returns no value.
30 30
 }
31
+\seealso{
32
+\url{https://jokergoo.github.io/ComplexHeatmap-reference/book/heatmap-decoration.html}
33
+}
31 34
 \author{
32 35
 Zuguang Gu <z.gu@dkfz.de>
33 36
 }
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
... ...
@@ -14,7 +14,7 @@ decorate_title(heatmap, code, slice = 1, which = c("column", "row"),
14 14
 
15 15
   \item{heatmap}{name of the heatmap}
16 16
   \item{code}{code that adds graphics in the selected heatmap body}
17
-  \item{slice}{index of row slices in the heatmap}
17
+  \item{slice}{index of row slice or column slice in the heatmap}
18 18
   \item{which}{on rows or on columns?}
19 19
   \item{envir}{where to look for variables inside \code{code}}
20 20
 
Browse code

decorate_*() adds envir

Zuguang Gu authored on 29/01/2017 20:43:42
Showing1 changed files
... ...
@@ -7,7 +7,8 @@ Decorate the heatmap title
7 7
 Decorate the heatmap title
8 8
 }
9 9
 \usage{
10
-decorate_title(heatmap, code, slice = 1, which = c("column", "row"))
10
+decorate_title(heatmap, code, slice = 1, which = c("column", "row"),
11
+    envir = new.env(parent = parent.frame()))
11 12
 }
12 13
 \arguments{
13 14
 
... ...
@@ -15,6 +16,7 @@ decorate_title(heatmap, code, slice = 1, which = c("column", "row"))
15 16
   \item{code}{code that adds graphics in the selected heatmap body}
16 17
   \item{slice}{index of row slices in the heatmap}
17 18
   \item{which}{on rows or on columns?}
19
+  \item{envir}{where to look for variables inside \code{code}}
18 20
 
19 21
 }
20 22
 \details{
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
... ...
@@ -12,16 +12,20 @@ decorate_title(heatmap, code, slice = 1, which = c("column", "row"))
12 12
 \arguments{
13 13
 
14 14
   \item{heatmap}{name of the heatmap}
15
-  \item{code}{code that is executed in the heatmap body}
15
+  \item{code}{code that adds graphics in the selected heatmap body}
16 16
   \item{slice}{index of row slices in the heatmap}
17 17
   \item{which}{on rows or on columns?}
18 18
 
19 19
 }
20 20
 \details{
21
-This simple function actually contructs the name of the viewport,
21
+There is a viewport for row titles and column title in the heatmap.
22
+This function contructs the name of the viewport,
22 23
 goes to the viewport by \code{\link[grid]{seekViewport}} and applies code
23 24
 to that viewport.
24 25
 }
26
+\value{
27
+The function returns no value.
28
+}
25 29
 \author{
26 30
 Zuguang Gu <z.gu@dkfz.de>
27 31
 }
Browse code

Commit made by the Bioconductor Git-SVN bridge.

Commit id: 1de356e1d1343725223e03ff696f931d80b2842b

Merge branch 'master' of https://github.com/jokergoo/mheatmap


Commit id: 478962957a34b7a5e87c8336989bae3df54f9559

change default colors



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

z.gu authored on 12/08/2015 22:03:22
Showing1 changed files
... ...
@@ -7,13 +7,15 @@ Decorate the heatmap title
7 7
 Decorate the heatmap title
8 8
 }
9 9
 \usage{
10
-decorate_title(heatmap, code, slice = 1, which = c("column", "row"))}
10
+decorate_title(heatmap, code, slice = 1, which = c("column", "row"))
11
+}
11 12
 \arguments{
12 13
 
13 14
   \item{heatmap}{name of the heatmap}
14 15
   \item{code}{code that is executed in the heatmap body}
15 16
   \item{slice}{index of row slices in the heatmap}
16 17
   \item{which}{on rows or on columns?}
18
+
17 19
 }
18 20
 \details{
19 21
 This simple function actually contructs the name of the viewport,
Browse code

Commit made by the Bioconductor Git-SVN bridge.

Commit id: f1b195419490dad46029cf7b681508ed21ba8c60

refreshed documentations



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

z.gu authored on 11/08/2015 10:42:08
Showing1 changed files
... ...
@@ -2,11 +2,9 @@
2 2
 \alias{decorate_title}
3 3
 \title{
4 4
 Decorate the heatmap title
5
-
6 5
 }
7 6
 \description{
8 7
 Decorate the heatmap title
9
-
10 8
 }
11 9
 \usage{
12 10
 decorate_title(heatmap, code, slice = 1, which = c("column", "row"))}
... ...
@@ -21,11 +19,9 @@ decorate_title(heatmap, code, slice = 1, which = c("column", "row"))}
21 19
 This simple function actually contructs the name of the viewport,
22 20
 goes to the viewport by \code{\link[grid]{seekViewport}} and applies code
23 21
 to that viewport.
24
-
25 22
 }
26 23
 \author{
27 24
 Zuguang Gu <z.gu@dkfz.de>
28
-
29 25
 }
30 26
 \examples{
31 27
 set.seed(123)
... ...
@@ -33,5 +29,4 @@ Heatmap(matrix(rnorm(100), 10), name = "mat", km = 2)
33 29
 decorate_title("mat", {
34 30
     grid.rect(gp = gpar(fill = "#FF000080"))
35 31
 }, which = "row", slice = 2)
36
-
37 32
 }
Browse code

Commit made by the Bioconductor Git-SVN bridge.

Commit id: 3429d28233ef2cbeafcd05307042d7c7aa54a2a2

add decorate* family functions



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

z.gu authored on 06/08/2015 16:40:59
Showing1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,37 @@
1
+\name{decorate_title}
2
+\alias{decorate_title}
3
+\title{
4
+Decorate the heatmap title
5
+
6
+}
7
+\description{
8
+Decorate the heatmap title
9
+
10
+}
11
+\usage{
12
+decorate_title(heatmap, code, slice = 1, which = c("column", "row"))}
13
+\arguments{
14
+
15
+  \item{heatmap}{name of the heatmap}
16
+  \item{code}{code that is executed in the heatmap body}
17
+  \item{slice}{index of row slices in the heatmap}
18
+  \item{which}{on rows or on columns?}
19
+}
20
+\details{
21
+This simple function actually contructs the name of the viewport,
22
+goes to the viewport by \code{\link[grid]{seekViewport}} and applies code
23
+to that viewport.
24
+
25
+}
26
+\author{
27
+Zuguang Gu <z.gu@dkfz.de>
28
+
29
+}
30
+\examples{
31
+set.seed(123)
32
+Heatmap(matrix(rnorm(100), 10), name = "mat", km = 2)
33
+decorate_title("mat", {
34
+    grid.rect(gp = gpar(fill = "#FF000080"))
35
+}, which = "row", slice = 2)
36
+
37
+}