Skip to content

Commit

Permalink
Merge pull request #195 from uclahs-cds/danknight-man-fixes
Browse files Browse the repository at this point in the history
Manual fixes for CRAN
  • Loading branch information
dan-knight authored Oct 3, 2024
2 parents e42b73f + b22d7f5 commit bf44ecb
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 5 deletions.
10 changes: 7 additions & 3 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@
## Changed

- Improved documentation for type parameter in `create.scatterplot`


## Fixed
- Fix typo in README
- Update package manual for CRAN standards

# BoutrosLab.plotting.general 7.1.0 (2023-10-26)

Expand Down Expand Up @@ -2003,7 +2007,7 @@ BoutrosLab.plotting.general 5.3.7
- `create.heatmap`: Use grobPack() fontfamily specification to avoid unknown Arial font specification
- `create.dotmap`: Changed yaxis label default to not be bold
- Legend.grob: Added parameters - 'layout', 'between.col', 'between.row' to allow user to specify layout for multiple legends and set empty space between rows/columns
- Legend.grob: Changed titles in legend to use a text grob instead of draw.key
- Legend.grob: Changed titles in legend to use a text grob instead of `draw.key`
- `create.heatmap`: Added 'legend.layout', 'legend.between.col', and 'legend.between.row' parameters

# BoutrosLab.plotting.general 3.5.4 (2012-11-02)
Expand Down Expand Up @@ -2067,7 +2071,7 @@ BoutrosLab.plotting.general 5.3.7
## Changed

- `create.heatmap`: Added code to close devices opened by the grid::covertUnit function and remove Rplots.pdf files if necessary
- Legend.grob: Added code to remove Rplots.pdf files created by the lattice::draw.key
- Legend.grob: Added code to remove Rplots.pdf files created by the lattice::`draw.key`

# BoutrosLab.plotting.general 3.4.0 (2012-09-12)

Expand All @@ -2088,7 +2092,7 @@ BoutrosLab.plotting.general 5.3.7

## Changed

- Legend.grob: Added code to close extra device created by the draw.key()
- Legend.grob: Added code to close extra device created by the `draw.key`()

# BoutrosLab.plotting.general 3.3.5 (2012-08-29)

Expand Down
3 changes: 2 additions & 1 deletion man/create.scatterplot.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -901,7 +901,8 @@ create.scatterplot(
xlab.cex = 1.5,
ylab.cex = 1.5,
# To plot ROC curve, add "s" or "S" to type vector.
# "s" connects points with the vertical segment first. "S" connects points with the horizontal segment first.
# "s" connects points with the vertical segment first.
# "S" connects points with the horizontal segment first.
type = 's',
lwd = 3,
add.xyline = TRUE,
Expand Down
2 changes: 1 addition & 1 deletion man/legend.grob.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The 'colours' component is a vector of fill colours to be used for the rectangle
}
\value{Returns an grob representing the legend(s)}
\author{Lauren Chong}
\seealso{\code{\link{create.heatmap}}, \code{\link{draw.key}}, \code{\link{gpar}}}
\seealso{\code{\link{create.heatmap}}, \code{\link[lattice]{draw.key}}, \code{\link{gpar}}}
\section{Implementation}{
This function was initially created to be called from \code{create.heatmap} to draw a covariate legend.\cr
The decision to use a grob (grid graphical object) to represent the legend was made based on the format of the \code{levelplot} function in the \code{lattice} package. Since the \code{legend} argument of the function requires grobs, it was easiest to create a grob to represent the legend and then, if necessary, add this to any existing grobs (dendrograms, etc.) in the \code{create.heatmap} function using a grid layout.\cr
Expand Down

0 comments on commit bf44ecb

Please sign in to comment.