envelope.envelope: Recompute Envelopes

Description

Given a simulation envelope (object of class "envelope"), compute another envelope from the same simulation data using different parameters.

Usage

## S3 method for class 'envelope':
envelope(Y, fun = NULL, ...)

Arguments

A simulation envelope (object of class "envelope").

fun

Optional. Summary function to be applied to the simulated point patterns.

...

Parameters controlling the type of envelope that is re-computed. See envelope.

Value

An envelope (object of class "envelope".

Details

This function can be used to re-compute a simulation envelope from previously simulated data, using different parameter settings for the envelope: for example, a different significance level, or a global envelope instead of a pointwise envelope.

The function envelope is generic. This is the method for the class "envelope". The argument Y should be a simulation envelope (object of class "envelope") produced by any of the methods for envelope.

If the argument fun is given, it should be a summary function that can be applied to the simulated point patterns that were used to create Y. Also, Y should contain these point patterns, so Y should have been created by calling envelope with savepatterns=TRUE. The envelope of the summary function fun for these point patterns will be computed using the parameters specified in ....

If fun is not given, then the new envelope will be computed from the same set of simulated function values that were used to compute Y. Also, Y should contain these function values, so Y should have been created by calling envelope with savefuns=TRUE. The envelope will be computed using the parameters specified in .... See envelope for a full list of envelope parameters. Frequently-used parameters include nrank and nsim (to change the number of simulations used and the significance level of the envelope), global (to change from pointwise to global envelopes) and VARIANCE (to compute the envelopes from the sample moments instead of the ranks).

Examples

Run this code

data(cells)
  E <- envelope(cells, Kest, nsim=19, savefuns=TRUE, savepatterns=TRUE)
  E2 <- envelope(E, nrank=2)
  Eg <- envelope(E, global=TRUE)
  EG <- envelope(E, Gest)