Arms (arm_table()), whole chromosomes (first to last bin), tiles of params$tile_sizes
(one per window_ids() window, named by tile_name(), end = min(start + size, chromosome end))
and named events, on the chromosomes that have usable bins (chrY only for males). Regions without a
usable bin are dropped. Columns follow vignette("scphasedcn-outputs", package = "scphasedcn"): n_bins / n_use count all / usable
bins under the containment rule; tiles are eligible when n_bins >= 0.9 * size / bin width and
n_use >= 0.7 * n_bins (the eligibility rule of the spike-in calibration), other regions when they
have a usable bin; null_region = arm, chrom and tile regions on autosomes not in null_exclude
(chromosome or region names); allelic_ok is FALSE on male chrX / chrY; sd_class by sd_class_of().
Usage
region_set(
bins,
centromeres,
classes = c("arm", "chrom", "5Mb", "10Mb", "20Mb", "50Mb"),
events = NULL,
sex = "female",
null_exclude = character(),
use = NULL,
params = caller_defaults()
)Arguments
- bins
bins table (chrom, start, end)
- centromeres
Battenberg centromere table or path (
arm_table())- classes
region classes to build (
arm,chrom, tile labels);eventis added wheneventsis given- events
NULL, a data.table
region, chrom, start, end(0-based half-open; NA end = chromosome end),cli_events()output or a named vector of region strings ("chr20:28000000-","chr7";parse_region()). An event without a name is named after its region string (a bare chromosome"chr7":"event|chr7"). An event that yields no region (a chromosome without usable bins, or no whole usable bin inside) is dropped with a warning.- sex
"female" or "male" (case-insensitive, or "F" / "M"; any other value stops)
- null_exclude
chromosomes (or region names) whose regions never contribute null rows
- use
logical bin filter (NULL = all bins)
- params
Value
regions data.table (passes check_regions())