Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Manual fixes for CRAN #195

Merged
merged 4 commits into from
Oct 3, 2024
Merged

Manual fixes for CRAN #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8793995
Fix lattice::draw.key reference in documentation
dan-knight Oct 2, 2024
10cf6eb
Fix comment length in manual
dan-knight Oct 2, 2024
84b1682
Update changelog
dan-knight Oct 2, 2024
b22d7f5
Link to lattice in manpage
dan-knight Oct 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions NEWS.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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}}}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this \code{\link{gpar}} have to be \code{\link[grid]{gpar}}? ordo we not need to do that for base R stuff?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this \code{\link{gpar}} have to be \code{\link[grid]{gpar}}? ordo we not need to do that for base R stuff?

I thought about that! I think that's the case, or something along those lines. R CMD check only had a problem with lattice - not grid. It may also be that gpar is used in the NAMESPACE, so it can automatically resolve.

\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
Loading