plot_2d_density: Density Plotter

In samplr: Compare Human Performance to Sampling Algorithms

Density Plotter

Description

Plots a 2D map of the density of a distribution. If plot = FALSE, returns a dataframe with the density for each cell in the grid

Usage

plot_2d_density(
  start,
  size,
  cellsPerRow = 50,
  names = NULL,
  params = NULL,
  weights = NULL,
  customDensity = NULL,
  plot = TRUE
)

Arguments

start	Vector c(x, y) with the coordinates of the bottom-left corner of the map.
size	Distance covered by the map. In other words, the top-right corner of the map has coordinates c(x + size, y + size)
cellsPerRow	Number of cells to plot in every row. The higher, the more resolution
names	Name of the distribution from which to sample from.
params	Distribution parameters.
weights	Distribution weights (if it's a mix of distributions)
customDensity	Instead of providing names, params and weights, the user may prefer to provide a custom density function.
plot	Whether to return a plot or a dataframe with the density in each coordinate

Value

Density Plot or dataframe

Examples

# plot supported distribution
plot_2d_density(
c(-5, -5), 10, cellsPerRow = 100, names = c("mvnorm", "mvnorm"),
params = list(list(c(-2,1), diag(2)), list(c(2,1), diag(2)))
)

# plot custom distribution
customDensity_r <- function(x){
    if (x[1] > 0 && x[1] < 3 && x[2] < 0 && x[2] > -3){
        return (1)
    } else {
        return (0)
    }
}
plot_2d_density(start = c(0,-4), size = 5, customDensity = customDensity_r)

samplr documentation built on April 4, 2025, 12:30 a.m.