archeofrag (version 1.2.0)

frag.get.layers.pair: Extracts the subgraph corresponding to a pair of archaeological spatial units.

Description

Extracts the subraph corresponding to a pair of archaeological spatial units (stratigraphic layers or any other type of spatial unit).

Usage

frag.get.layers.pair(graph, layer.attr, sel.layers, size.mini=2,
                     mixed.components.only=FALSE, verbose=TRUE)

Value

An undirected graph object.

Arguments

graph

An igraph object.

layer.attr

Character. The name of the vertices attribute giving the spatial unit of each fragment.

sel.layers

A numeric vector of length 2 with the name of the spatial unit selected for extraction.

size.mini

A minimal number of vertices for the components to include in the resulting graph.

mixed.components.only

Logical. If TRUE, only the components with fragments from the two selected spatial units are returned. If FALSE, all the components of the two spatial units are extracted.

verbose

Logical. Whether to print or not warning messages.

Author

Sebastien Plutniak <sebastien.plutniak at posteo.net>

Details

The default setting of the mixed.components.only argument is FALSE, for convenience for other measurements.

Examples

g <- frag.simul.process(n.components=20, vertices=50, disturbance=.15)
igraph::V(g)$layers <- c(rep("layer1", 20), rep("layer2", 20), rep("layer3", 10))

frag.get.layers.pair(g, "layers", sel.layers=c("layer2","layer3"),
                     size.mini=2, mixed.components.only=FALSE)
frag.get.layers.pair(g, "layers", sel.layers=c("layer2","layer3"),  
                     size.mini=2, mixed.components.only=TRUE)