Skip to contents

helper function to check the input of binning

Usage

.check_binning(bin_param, bin_type, range_list)

Arguments

bin_param

A numeric vector indicating the size of the bin. If the bin_type is "square" or "rectangle", this will be a vector of length two giving the numbers of rectangular quadrats in the x and y directions. If the bin_type is "hexagonal", this will be a number giving the side length of hexagons. Positive numbers only.

bin_type

A string indicating which bin shape is to be used for vectorization. One of "square" (default), "rectangle", or "hexagon".

range_list

A named list of spatial ranges for each sample. Each element should be a list with two components: w_x and w_y, which are numeric vectors of length 2 specifying the x- and y-axis ranges (e.g., from cell or transcript coordinates). The range is calculated with 5 within the window.

Value

the length of total bins