check_mask: Check Mask is Binary

Description Usage Arguments Value Examples

View source: R/check_mask.R

Description

Determine if only values in a mask are 0/1

Usage

1
check_mask(mask, allow.NA = FALSE, allow.array = TRUE)

Arguments

mask

Object of class nifti

allow.NA

allow NAs in the mask

allow.array

if class(mask) is "array", is this OK?

Value

Logical indicating if object is binary mask with only 0, 1, and NA if applicable

Examples

1
2
3
arr = array(rbinom(1000, size = 1, prob = 0.2), dim = c(10,10,10))
nim = oro.nifti::nifti(arr)
check_mask(nim)

neuroconductor-devel/neurobase documentation built on May 6, 2021, 1:48 p.m.