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,36 +0,0 @@
1
-\name{max_text_height}
2
-\alias{max_text_height}
3
-\title{
4
-Maximum Height of Text
5
-}
6
-\description{
7
-Maximum Height of Text
8
-}
9
-\usage{
10
-max_text_height(text, gp = gpar(), rot = 0)
11
-}
12
-\arguments{
13
-
14
-  \item{text}{A vector of text.}
15
-  \item{gp}{Graphic parameters for text.}
16
-  \item{rot}{Rotation of the text, scalar.}
17
-
18
-}
19
-\details{
20
-It simply calculates maximum height of a list of \code{\link[grid:grid.text]{textGrob}} objects.
21
-
22
-Note it ignores the text rotation.
23
-}
24
-\value{
25
-A \code{\link[grid]{unit}} object.
26
-}
27
-\author{
28
-Zuguang Gu <z.gu@dkfz.de>
29
-}
30
-\seealso{
31
-\code{\link{max_text_width}} calculates the maximum width of a text vector.
32
-}
33
-\examples{
34
-x = c("a", "b\nb", "c\nc\nc")
35
-max_text_height(x, gp = gpar(fontsize = 10))
36
-}
Browse code

add labels_rot argument to anno_mark()

Zuguang Gu authored on 02/07/2019 20:34:44
Showing1 changed files
... ...
@@ -7,12 +7,13 @@ Maximum Height of Text
7 7
 Maximum Height of Text
8 8
 }
9 9
 \usage{
10
-max_text_height(text, gp = gpar())
10
+max_text_height(text, gp = gpar(), rot = 0)
11 11
 }
12 12
 \arguments{
13 13
 
14 14
   \item{text}{A vector of text.}
15 15
   \item{gp}{Graphic parameters for text.}
16
+  \item{rot}{Rotation of the text, scalar.}
16 17
 
17 18
 }
18 19
 \details{
Browse code

fix warnings in Rd files

Zuguang Gu authored on 28/11/2018 09:32:19
Showing1 changed files
... ...
@@ -16,7 +16,7 @@ max_text_height(text, gp = gpar())
16 16
 
17 17
 }
18 18
 \details{
19
-It simply calculates maximum height of a list of \code{\link[grid]{textGrob}} objects.
19
+It simply calculates maximum height of a list of \code{\link[grid:grid.text]{textGrob}} objects.
20 20
 
21 21
 Note it ignores the text rotation.
22 22
 }
Browse code

documentation checked

Zuguang Gu authored on 23/10/2018 19:59:12
Showing1 changed files
... ...
@@ -16,7 +16,7 @@ max_text_height(text, gp = gpar())
16 16
 
17 17
 }
18 18
 \details{
19
-Simply calculate maximum height of a list of \code{\link[grid]{textGrob}} objects.
19
+It simply calculates maximum height of a list of \code{\link[grid]{textGrob}} objects.
20 20
 
21 21
 Note it ignores the text rotation.
22 22
 }
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,32 +1,34 @@
1 1
 \name{max_text_height}
2 2
 \alias{max_text_height}
3 3
 \title{
4
-Maximum height of text
4
+Maximum Height of Text
5 5
 }
6 6
 \description{
7
-Maximum height of text
7
+Maximum Height of Text
8 8
 }
9 9
 \usage{
10
-max_text_height(text, ...)
10
+max_text_height(text, gp = gpar())
11 11
 }
12 12
 \arguments{
13 13
 
14
-  \item{text}{a vector of text}
15
-  \item{...}{pass to \code{\link[grid]{textGrob}}}
14
+  \item{text}{A vector of text.}
15
+  \item{gp}{Graphic parameters for text.}
16 16
 
17 17
 }
18 18
 \details{
19 19
 Simply calculate maximum height of a list of \code{\link[grid]{textGrob}} objects.
20
+
21
+Note it ignores the text rotation.
20 22
 }
21 23
 \value{
22 24
 A \code{\link[grid]{unit}} object.
23 25
 }
24
-\seealso{
25
-\code{\link{max_text_height}} is always used to calculate the size of viewport when there is text annotation (\code{\link{anno_text}})
26
-}
27 26
 \author{
28 27
 Zuguang Gu <z.gu@dkfz.de>
29 28
 }
29
+\seealso{
30
+\code{\link{max_text_width}} calculates the maximum width of a text vector.
31
+}
30 32
 \examples{
31 33
 x = c("a", "b\nb", "c\nc\nc")
32 34
 max_text_height(x, gp = gpar(fontsize = 10))
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
... ...
@@ -14,13 +14,20 @@ max_text_height(text, ...)
14 14
   \item{text}{a vector of text}
15 15
   \item{...}{pass to \code{\link[grid]{textGrob}}}
16 16
 
17
+}
18
+\details{
19
+Simply calculate maximum height of a list of \code{\link[grid]{textGrob}} objects.
17 20
 }
18 21
 \value{
19 22
 A \code{\link[grid]{unit}} object.
20 23
 }
24
+\seealso{
25
+\code{\link{max_text_height}} is always used to calculate the size of viewport when there is text annotation (\code{\link{anno_text}})
26
+}
21 27
 \author{
22 28
 Zuguang Gu <z.gu@dkfz.de>
23 29
 }
24 30
 \examples{
25
-max_text_height(letters, gp = gpar(fontsize = 10))
31
+x = c("a", "b\nb", "c\nc\nc")
32
+max_text_height(x, gp = gpar(fontsize = 10))
26 33
 }
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
... ...
@@ -15,3 +15,12 @@ max_text_height(text, ...)
15 15
   \item{...}{pass to \code{\link[grid]{textGrob}}}
16 16
 
17 17
 }
18
+\value{
19
+A \code{\link[grid]{unit}} object.
20
+}
21
+\author{
22
+Zuguang Gu <z.gu@dkfz.de>
23
+}
24
+\examples{
25
+max_text_height(letters, gp = gpar(fontsize = 10))
26
+}
Browse code

Commit made by the Bioconductor Git-SVN bridge.

Commit id: 5092f735f37e38376bf0f9e9e91ae4fd43f0b46d

refreshed docs


Commit id: 41176f68f10188ca00773a0a279dcd67ea30ffd5

heatmap component can all have absolute units



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

z.gu authored on 18/08/2015 13:35:51
Showing1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,17 @@
1
+\name{max_text_height}
2
+\alias{max_text_height}
3
+\title{
4
+Maximum height of text
5
+}
6
+\description{
7
+Maximum height of text
8
+}
9
+\usage{
10
+max_text_height(text, ...)
11
+}
12
+\arguments{
13
+
14
+  \item{text}{a vector of text}
15
+  \item{...}{pass to \code{\link[grid]{textGrob}}}
16
+
17
+}