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.

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

Minor break function for log10 ticks #452

Merged
merged 6 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ Config/testthat/edition: 3
Encoding: UTF-8
LazyLoad: yes
Roxygen: list(markdown = TRUE, r6 = FALSE)
RoxygenNote: 7.2.3
RoxygenNote: 7.3.2
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ export(log_trans)
export(logit_trans)
export(manual_pal)
export(math_format)
export(minor_breaks_log)
export(minor_breaks_n)
export(minor_breaks_width)
export(modulus_trans)
Expand Down
83 changes: 83 additions & 0 deletions R/breaks-log.R
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,89 @@ breaks_log <- function(n = 5, base = 10) {
#' @rdname breaks_log
log_breaks <- breaks_log

#' Minor breaks for log-10 axes
#'
#' This break function is designed to mark every power, multiples of 5 and/or 1
#' of that power for base 10.
#'
#' @param detail Any of `1`, `5` and `10` to mark multiples of
#' powers, multiples of 5 of powers or just powers respectively.
#' @param smallest Smallest absolute value to mark when the range includes
#' negative numbers.
#'
#' @return A function to generate minor ticks.
#' @export
#'
#' @examples
#' # Standard usage with log10 scale
#' demo_log10(c(1, 1e10), minor_breaks = minor_breaks_log())
#' # Increasing detail over many powers
#' demo_log10(c(1, 1e10), minor_breaks = minor_breaks_log(detail = 1))
#' # Adjusting until where to draw minor breaks
#' demo_continuous(
#' c(-1000, 1000),
#' transform = asinh_trans(),
#' minor_breaks = minor_breaks_log(smallest = 1)
#' )
minor_breaks_log <- function(detail = NULL, smallest = NULL) {
if (!is.null(detail) && (!length(detail) == 1 || !detail %in% c(1, 5, 10))) {
cli::cli_abort("The {.arg detail} argument must be one of 1, 5 or 10.")
}
if (!is.null(smallest) &&
(!length(smallest) == 1 || smallest < 1e-100 || !is.finite(smallest))) {
cli::cli_abort(
"The {.arg smallest} argument must be a finite, positive, non-zero number."
)
}
force(smallest)
function(x, ...) {

has_negatives <- any(x <= 0)

if (has_negatives) {
large <- max(abs(x))
small <- smallest %||% min(c(1, large) * 0.1)
x <- sort(c(small * 10, large))
}

start <- floor(log10(min(x))) - 1L
end <- ceiling(log10(max(x))) + 1L

if (is.null(detail)) {
i <- findInterval(abs(end - start), c(8, 15), left.open = TRUE) + 1L
detail <- c(1, 5, 10)[i]
}

ladder <- 10^seq(start, end, by = 1L)
tens <- fives <- ones <- numeric()
if (detail %in% c(10, 5, 1)) {
tens <- ladder
}
if (detail %in% c(5, 1)) {
fives <- 5 * ladder
}
if (detail == 1) {
ones <- as.vector(outer(1:9, ladder))
ones <- setdiff(ones, c(tens, fives))
}

if (has_negatives) {
tens <- tens[tens >= small]
tens <- c(tens, -tens, 0)
fives <- fives[fives >= small]
fives <- c(fives, -fives)
ones <- ones[ones >= small]
ones <- c(ones, -ones)
}

ticks <- c(tens, fives, ones)
n <- c(length(tens), length(fives), length(ones))

attr(ticks, "detail") <- rep(c(10, 5, 1), n)
ticks
}
}

#' @author Thierry Onkelinx, \email{[email protected]}
#' @noRd
log_sub_breaks <- function(rng, n = 5, base = 10) {
Expand Down
1 change: 1 addition & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ reference:
contents:
- starts_with("breaks_")
- minor_breaks_width
- minor_breaks_log

- title: "Bounds: ranges & rescaling"
desc: >
Expand Down
34 changes: 34 additions & 0 deletions man/minor_breaks_log.Rd

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

29 changes: 29 additions & 0 deletions tests/testthat/test-breaks-log.R
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,32 @@ test_that("breaks_log with very small ranges fall back to extended_breaks", {
extended_breaks(n = 5)(c(0.95, 3))
))
})

test_that("minor_breaks_log has correct amount of detail", {
range <- c(1, 10)

test <- minor_breaks_log(detail = 1)(range)
expect_true(all(1:10 %in% test))

test <- minor_breaks_log(detail = 5)(range)
expect_false(all(1:10 %in% test))
expect_true(all(c(1, 5, 10) %in% test))

test <- minor_breaks_log(detail = 10)(range)
expect_true(all(c(1, 10) %in% test))
expect_false(5 %in% test)

test <- minor_breaks_log(detail = 1)(c(-10, 10))
expect_true(all(-10:10 %in% test))
})

test_that("minor_breaks_log rejects invalid arguments", {
expect_error(
minor_breaks_log(7),
"must be one of 1, 5 or 10"
)
expect_error(
minor_breaks_log(smallest = 0),
"must be a finite, positive, non-zero number."
)
teunbrand marked this conversation as resolved.
Show resolved Hide resolved
})
Loading