Skip to content

Commit

Permalink
docs: Add missing package anchors
Browse files Browse the repository at this point in the history
* Added missing package anchors to a few Rd cross-references (#128).

closes #128
  • Loading branch information
trevorld committed Dec 11, 2024
1 parent 5d3c1de commit 2bef789
Show file tree
Hide file tree
Showing 14 changed files with 29 additions and 23 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: ggpattern
Type: Package
Title: 'ggplot2' Pattern Geoms
Version: 1.1.1
Version: 1.1.2-1
Authors@R: c(person("Mike", "FC", role = "aut"),
person("Trevor L.", "Davis", role = c("aut", "cre"),
email = "[email protected]",
Expand Down
6 changes: 6 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# ggpattern 1.1.2 (development)

## Bug fixes and minor improvements

* Added missing package anchors to a few Rd cross-references (#128).

# ggpattern 1.1.1

## Breaking changes
Expand Down
2 changes: 1 addition & 1 deletion R/geom-.R
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ create_key_pattern_grob <- function(data, params, size, aspect_ratio, boundary_d
#' to be displayed in a legend. These functions are called `draw_key_*()`, where
#' `*` stands for the name of the respective key glyph. The key glyphs can be
#' customized for individual geoms by providing a geom with the `key_glyph`
#' argument (see [`layer()`] or examples below.)
#' argument (see [ggplot2::layer()] or examples below.)
#'
#' @param data A single row data frame containing the scaled aesthetics to
#' display in this key
Expand Down
6 changes: 3 additions & 3 deletions R/scale-pattern-alpha.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' Alpha transparency scales
#'
#' See \code{ggplot2::scale_alpha()} for details.
#' See [ggplot2::scale_alpha()] for details.
#'
#' @param ... Other arguments passed on to [continuous_scale()], [binned_scale],
#' or [discrete_scale()] as appropriate, to control name, limits,
#' @param ... Other arguments passed on to [ggplot2::continuous_scale()], [ggplot2::binned_scale()],
#' or [ggplot2::discrete_scale()] as appropriate, to control name, limits,
#' breaks, labels and so forth.
#' @param range Output range of alpha values. Must lie between 0 and 1.
#' @examples
Expand Down
4 changes: 2 additions & 2 deletions R/scale-pattern-brewer.R
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@
#' @param palette If a string, will use that named palette. If a number, will index into
#' the list of palettes of appropriate `type`. The list of available palettes can found
#' in the Palettes section.
#' @param ... Other arguments passed on to [discrete_scale()], [continuous_scale()],
#' or [binned_scale()], for `brewer`, `distiller`, and `fermenter` variants
#' @param ... Other arguments passed on to [ggplot2::discrete_scale()], [ggplot2::continuous_scale()],
#' or [ggplot2::binned_scale()], for `brewer`, `distiller`, and `fermenter` variants
#' respectively, to control name, limits, breaks, labels and so forth.
#' @examples
#' if (require("ggplot2")) {
Expand Down
2 changes: 1 addition & 1 deletion R/scale-pattern-linetype.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#' University of Manchester. Continuous values can not be mapped to
#' line types.
#'
#' @param ... see \code{ggplot2::scale_linetype} for more information
#' @param ... see [ggplot2::scale_linetype()] for more information
#' @param na.value The linetype to use for `NA` values.
#' @return A [ggplot2::Scale] object.
#' @examples
Expand Down
6 changes: 3 additions & 3 deletions R/scale-pattern-viridis.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
#' with common forms of colour blindness. See also
#' <https://bids.github.io/colormap/>.
#'
#' @param begin,end,alpha,direction,option,values,space,na.value,guide See \code{ggplot2::scale_colour_viridis_d} for more information
#' @param ... Other arguments passed on to [discrete_scale()],
#' [continuous_scale()], or [binned_scale] to control name, limits, breaks,
#' @param begin,end,alpha,direction,option,values,space,na.value,guide See [ggplot2::scale_colour_viridis_d()] for more information
#' @param ... Other arguments passed on to [ggplot2::discrete_scale()],
#' [ggplot2::continuous_scale()], or [ggplot2::binned_scale()] to control name, limits, breaks,
#' labels and so forth.
#' @param aesthetics Character string or vector of character strings listing the
#' name(s) of the aesthetic(s) that this scale works with. This can be useful, for
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ if (FALSE) {
<!-- badges: start -->
[![CRAN Status Badge](https://www.r-pkg.org/badges/version/ggpattern)](https://cran.r-project.org/package=ggpattern)
![](http://img.shields.io/badge/cool-useless-green.svg)
[![R build status](https://github.com/trevorld/ggpattern/workflows/R-CMD-check/badge.svg)](https://github.com/trevorld/ggpattern/actions)
[![R build status](https://github.com/trevorld/ggpattern/actions/workflows/R-CMD-check.yaml/badge.svg?branch=master)](https://github.com/trevorld/ggpattern/actions)
<!-- badges: end -->

<span style="font-size: xx-large; font-weight: normal;">`ggpattern` provides custom `ggplot2` geoms which support filled areas with
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ output: github_document
<!-- badges: start -->
[![CRAN Status Badge](https://www.r-pkg.org/badges/version/ggpattern)](https://cran.r-project.org/package=ggpattern)
![](http://img.shields.io/badge/cool-useless-green.svg)
[![R build status](https://github.com/trevorld/ggpattern/workflows/R-CMD-check/badge.svg)](https://github.com/trevorld/ggpattern/actions)
[![R build status](https://github.com/trevorld/ggpattern/actions/workflows/R-CMD-check.yaml/badge.svg?branch=master)](https://github.com/trevorld/ggpattern/actions)
<!-- badges: end -->

<span style="font-size: xx-large; font-weight: normal;">`ggpattern` provides custom `ggplot2` geoms which support filled areas with
Expand Down
2 changes: 1 addition & 1 deletion man/draw_key_polygon_pattern.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/scale_pattern_alpha_continuous.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/scale_pattern_colour_brewer.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/scale_pattern_colour_viridis_d.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/scale_pattern_linetype.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 2bef789

Please sign in to comment.