summarize_envelope: summarize_envelope

Description Usage Arguments Details Value See Also Examples

View source: R/summarize_envelope.R

Description

Summarize simulation envelope

Usage

1
summarize_envelope(x, plot_result = FALSE)

Arguments

x

fv

plot_result

A plot is drawn.

Details

The area above and below the null model envelope is divided by the total area under the curve. If seperated = TRUE, the first returning value is the relative area above, the second value the relative value below the envelope. If seperated = FALSE the value is the absolute sum of both ratio. If the value is positive, the area above the envelope is larger than the value below the envelope. If the value is negative, the area under the envelope is larger than the value above the envelope.

The returned env_summarized object includes information about the area under the curve where the summary function observed pattern is above or below the null model envelopes.

Value

env_summarized

See Also

envelope

Examples

1
2
3
4
5
6
7
set.seed(42)
input_pattern <- spatstat.core::rThomas(kappa = 15, scale = 0.05, mu = 5)

cluster_env <- spatstat.core::envelope(input_pattern, fun = "pcf", nsim = 39,
funargs = list(divisor = "d", correction = "Ripley", stoyan = 0.25))

summarize_envelope(cluster_env)

onpoint documentation built on Sept. 9, 2021, 9:07 a.m.