Skip to content

Respect user-supplied color range given zero-variance data #42

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

Open
mdoucleff wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Respect user-supplied color range given zero-variance data #42

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
cc0a49b
Respect color range min_value and max_value
mdoucleff Nov 3, 2022
c4bb01a
Ensure range checking occurs before normalization
mdoucleff Nov 3, 2022
aedec5f
Update color_tiles.R
mdoucleff Nov 3, 2022
4a0700e
Syntax fix
mdoucleff Nov 3, 2022
878bb25
Fix renamed variable
mdoucleff Nov 3, 2022
2521a95
Copy fix to similar section
mdoucleff Nov 3, 2022
2d7ed9a
Allow data values to exceed color extents
mdoucleff Nov 4, 2022
5c4d9fc
Update docs to reflect clamping behavior
mdoucleff Nov 4, 2022
bc70309
Reduce total change size
mdoucleff Nov 4, 2022
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
82 changes: 30 additions & 52 deletions R/color_tiles.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,9 @@
#' Default is NULL.
#'
#' @param min_value The minimum value used for the color assignments.
#' This value must expand the range of the data within the column.
#' Therefore, the value must be less than or equal to the minimum value within the column.
#' Default is NULL.
#'
#' @param max_value The maximum value used for the color assignments.
#' This value must expand the range of the data within the column.
#' Therefore, the value must be greater than or equal to the maximum value within the column.
#' Default is NULL.
#'
#' @param even_breaks Logical: if TRUE, the colors will be assigned to values in distinct quantile bins rather than on a normalized scale.
Expand Down Expand Up @@ -451,25 +447,22 @@ color_tiles <- function(data,

if (is.character(color_by)) { color_by <- which(names(data) %in% color_by) }

# if there is no variance in the column, assign the same color to each value
if (is.numeric(data[[color_by]]) & mean((data[[color_by]] - mean(data[[color_by]], na.rm=TRUE)) ^ 2, na.rm=TRUE) == 0) {

normalized <- 1

} else {

# user supplied min and max values
if (is.null(min_value)) {
min_value_color_by <- min(data[[color_by]], na.rm = TRUE)
} else { min_value_color_by <- min_value }
# user supplied min and max values
if (is.null(min_value)) {
min_value_color_by <- min(data[[color_by]], na.rm = TRUE)
} else { min_value_color_by <- min_value }

if (is.null(max_value)) {
max_value_color_by <- max(data[[color_by]], na.rm = TRUE)
} else { max_value_color_by <- max_value }
if (is.null(max_value)) {
max_value_color_by <- max(data[[color_by]], na.rm = TRUE)
} else { max_value_color_by <- max_value }

range <- max_value_color_by - min_value_color_by

normalized <- (data[[color_by]][index] - min_value_color_by) / (max_value_color_by - min_value_color_by)
# range zero occurs for constant-valued columns (including single row tables)
normalized <- if (range > 0) (data[[color_by]][index] - min_value_color_by) / range else 1

}
# clamp data to [0,1] range
normalized <- pmax(pmin(normalized, 1), 0)

cell_color <- color_pal(normalized)
cell_color <- suppressWarnings(grDevices::adjustcolor(cell_color, alpha.f = opacity))
Expand All @@ -481,38 +474,23 @@ color_tiles <- function(data,
}

} else {

# standard normalization (no variance check)
if (is.numeric(value) & mean((data[[name]] - mean(data[[name]], na.rm=TRUE)) ^ 2, na.rm=TRUE) == 0) {

normalized <- 1

} else {

# user supplied min and max values
if (is.null(min_value)) {
min_value_normal <- min(data[[name]], na.rm = TRUE)
} else { min_value_normal <- min_value }

if (is.null(max_value)) {
max_value_normal <- max(data[[name]], na.rm = TRUE)
} else { max_value_normal <- max_value }

# standard normalization
normalized <- (value - min_value_normal) / (max_value_normal - min_value_normal)

}

if (!is.null(min_value) & isTRUE(min_value > min(data[[name]], na.rm = TRUE))) {

stop("`min_value` must be less than the minimum value observed in the data")
}

if (!is.null(max_value) & isTRUE(max_value < max(data[[name]], na.rm = TRUE))) {

stop("`max_value` must be greater than the maximum value observed in the data")
}


# user supplied min and max values
if (is.null(min_value)) {
min_value_normal <- min(data[[name]], na.rm = TRUE)
} else { min_value_normal <- min_value }

if (is.null(max_value)) {
max_value_normal <- max(data[[name]], na.rm = TRUE)
} else { max_value_normal <- max_value }

# range zero occurs for constant-valued columns (including single row tables)
range <- max_value_normal - min_value_normal
normalized <- if (range > 0) (value - min_value_normal) / range else 1

# clamp data to [0,1] range
normalized <- pmax(pmin(normalized, 1), 0)

cell_color <- color_pal(normalized)
cell_color <- suppressWarnings(grDevices::adjustcolor(cell_color, alpha.f = opacity))
font_color <- assign_color(normalized)
Expand Down