null_distribution: Create a null distribution object

In neuromapr: Spatial Null Models and Transforms for Brain Map Comparison

Create a null distribution object

Description

Create a null distribution object

Usage

new_null_distribution(nulls, method, observed, params = list())

## S3 method for class 'null_distribution'
print(x, ...)

## S3 method for class 'null_distribution'
summary(object, ...)

## S3 method for class 'null_distribution'
as.matrix(x, ...)

## S3 method for class 'null_distribution'
plot(x, parcel = 1L, ...)

Arguments

nulls	Numeric matrix (n x n_perm) of surrogate values.
method	Character string identifying the null model method.
observed	Numeric vector of original data values.
params	Named list of algorithm parameters.
x	A null_distribution object.
...	Ignored.
object	A null_distribution object.
parcel	Integer index of the parcel to plot.

Value

A null_distribution object.

Examples

nulls <- matrix(rnorm(30), nrow = 3, ncol = 10)
nd <- new_null_distribution(nulls, "test", observed = c(1, 2, 3))
print(nd)
summary(nd)

neuromapr documentation built on Feb. 27, 2026, 5:08 p.m.