dyad_id: Dyad ID
In robitalec/toast: Very Dry

Description Usage Arguments Details Value Examples

View source: R/dyad_id.R

Build unique ID for dyads of focal individuals (and neighbours).

1	dyad_id(DT = NULL, focal = "id", neighbour = NULL, both = FALSE)

`DT`	data.table.
`focal`	focal individual.
`neighbour`	neighbours, optional - see Details.
`both`	if both is TRUE, returns duplicated dyadIDs with all focal/neighbour inverted and appended.

This function builds a dyad ID: focal A -> neighbour B (and focal B -> neighbour A) = dyad 1.

If neighbour is not provided, all potential dyads are returned as a "dyad dictionary".

Alternatively, when observed neighbours are provided, a "dyadID" column is added to the data.table with the individuals

# Load data.table
library(data.table)

# Read example data
DT <- fread(system.file("extdata", "DT.csv", package = "toast"))

dyadDict <- dyad_id(DT, focal = 'ID', neighbour = NULL)