calc_hwi: Calculate HWI

Description Usage Arguments Details Value See Also Examples

View source: R/hwig.R

Description

Calculates the Half-Weight Association Index

Usage

1
calc_hwi(DT, id, group, by = NULL)

Arguments

DT

input group membership data, in individual/group format

id

column indicating id in DT

group

column indicating group in DT

by

column(s) to split calculation by. e.g.: year

Details

Expects an input 'DT' with id and group column, e.g. as returned by group_pts.

Value

HWI data.table or list of data.tables.

See Also

calc_hwig

Examples

1
2
3
4
5
6
7
8
# Load data.table
library(data.table)

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

# Calculate HWI
hwi <- calc_hwi(DT, 'id', 'group', 'yr')

hwig documentation built on Sept. 30, 2021, 5:08 p.m.