Skip to contents

print.env_summarized

Source: R/print.env_summarized.R
print.env_summarized.Rd

Print method for env_summarized object

Usage

# S3 method for class 'env_summarized'
print(x, return_area = FALSE, digits = 2, ...)

Arguments

x

Random patterns.

return_area

If true, not the ratio but the area is returned.

digits

Number of decimal places (round).

...

Arguments passed to cat

Value

No return value

Details

Printing method for summarized envelope created with summarize_envelope.

See also

summarize_envelope

Examples

set.seed(42)
input_pattern <- spatstat.random::rThomas(kappa = 15, scale = 0.05, mu = 5)

cluster_env <- spatstat.explore::envelope(input_pattern, fun = "pcf", nsim = 39,
funargs = list(divisor = "d", correction = "Ripley", stoyan = 0.25))
#> Generating 39 simulations of CSR  ...
#> 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20,
#> 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 
#> 39.
#> 
#> Done.

x <- summarize_envelope(cluster_env)
print(x)
#> Total ratio: 27.42% 
#> ------------ 
#> Above ratio: 27.42% 
#> Below ratio: 0%