spatstat.core: collapse.fv – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

collapse.fv

Collapse Several Function Tables into One

Description

Combines several function tables (objects of class "fv") into a single function table, merging columns that are identical and relabelling columns that are different.

Usage

## S3 method for class 'fv'
collapse(object, ..., same = NULL, different = NULL)

## S3 method for class 'anylist'
collapse(object, ..., same = NULL, different = NULL)

Arguments

`object`	An object of class `"fv"`, or a list of such objects.
`...`	Additional objects of class `"fv"`.
`same`	Character string or character vector specifying a column or columns, present in each `"fv"` object, that are identical in each object. This column or columns will be included only once.
`different`	Character string or character vector specifying a column or columns, present in each `"fv"` object, that contain different values in each object. Each of these columns of data will be included, with labels that distinguish them from each other.

Details

This is a method for the generic function collapse.

It combines the data in several function tables (objects of class "fv", see fv.object) to make a single function table. It is essentially a smart wrapper for cbind.fv.

A typical application is to calculate the same summary statistic (such as the K function) for different point patterns, and then to use collapse.fv to combine the results into a single object that can easily be plotted. See the Examples.

The arguments object and ... should be function tables (objects of class "fv", see fv.object) that are compatible in the sense that they have the same values of the function argument.

The argument same identifies any columns that are present in each function table, and which are known to contain exactly the same values in each table. This column or columns will be included only once in the result.

The argument different identifies any columns that are present in each function table, and which contain different numerical values in each table. Each of these columns will be included, with labels to distinguish them.

Columns that are not named in same or different will not be included.

The arguments same and different can be NULL, or they can be character vectors containing the names of columns of object. The argument different can be one of the abbreviations recognised by fvnames.

Value

Object of class "fv".

Author(s)

Adrian Baddeley Adrian.Baddeley@curtin.edu.au and Rolf Turner r.turner@auckland.ac.nz

Examples

# generate simulated data
  X <- replicate(3, rpoispp(100), simplify=FALSE)
  names(X) <- paste("Simulation", 1:3)
  # compute K function estimates
  Klist <- anylapply(X, Kest)
  # collapse
  K <- collapse(Klist, same="theo", different="iso")
  K

spatstat.core

Core Functionality of the 'spatstat' Family

v2.1-2

GPL (>= 2)

Authors

Adrian Baddeley [aut, cre], Rolf Turner [aut], Ege Rubak [aut], Kasper Klitgaard Berthelsen [ctb], Achmad Choiruddin [ctb], Jean-Francois Coeurjolly [ctb], Ottmar Cronie [ctb], Tilman Davies [ctb], Julian Gilbey [ctb], Yongtao Guan [ctb], Ute Hahn [ctb], Kassel Hingee [ctb], Abdollah Jalilian [ctb], Marie-Colette van Lieshout [ctb], Greg McSwiggan [ctb], Tuomas Rajala [ctb], Suman Rakshit [ctb], Dominic Schuhmacher [ctb], Rasmus Plenge Waagepetersen [ctb], Hangsheng Wang [ctb]

Initial release

2021-04-17