Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jokergoo committed Jun 8, 2020
1 parent 02ee31b commit b1452fd
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 1 deletion.
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ export("read.chromInfo")
export("read.cytoband")
export("reverse.circlize")
export("set.current.cell")
export("set_track_gap")
export("show.index")
export("smartAlign")
export("uh")
Expand Down
4 changes: 3 additions & 1 deletion man/circos.link.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ circos.link(
arr.type = "triangle",
arr.lty = lty,
arr.lwd = lwd,
arr.col = col)
arr.col = col,
reduce_to_mid_line = FALSE)
}
\arguments{

Expand All @@ -57,6 +58,7 @@ circos.link(
\item{arr.col}{Color of the arrows, pass to \code{\link[shape]{Arrowhead}}.}
\item{arr.lwd}{Line width of arrows, pass to \code{\link[shape]{Arrowhead}}.}
\item{arr.lty}{Line type of arrows, pass to \code{\link[shape]{Arrowhead}}.}
\item{reduce_to_mid_line}{Only use the middle points of \code{point1} and \code{point2} to draw the link.}

}
\details{
Expand Down
23 changes: 23 additions & 0 deletions man/set_track_gap.Rd
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
\name{set_track_gap}
\alias{set_track_gap}
\title{
Set gaps between tracks
}
\description{
Set gaps between tracks
}
\usage{
set_track_gap(gap = 0.02)
}
\arguments{

\item{gap}{Gap between two tracks}

}
\examples{
circos.initialize(fa = letters[1:10], xlim = c(0, 1))
circos.track(ylim = c(0, 1))
set_track_gap(mm_h(2))
circos.track(ylim = c(0, 1))
circos.clear()
}

0 comments on commit b1452fd

Please sign in to comment.