Learn R Programming

popkin (version 1.2.2)

neff-deprecated: Calculates the effective sample size of the data

Description

Calculates the effective sample size of the data

Usage

neff(kinship, max = TRUE, w = NULL, retW = TRUE, nonneg = TRUE,
algo = c('gradient', 'newton', 'heuristic'), tol = 1e-10)

Arguments

kinship

A kinship matrix

max

Return maximum \(n_{eff}\); otherwise compute \(n_{eff}\) using provided weights.

w

Weights for individuals.

retW

Return weights along with \(n_{eff}\).

nonneg

Optimize constrained to non-negative weights.

algo

Algorithm for finding optimal non-negative weights: gradient, newton, or heuristic.

tol

Tolerance parameter for "gradient" and "newton" algorithms.

Value

A list containing \(n_{eff}\) and the weights.

See Also

popkin-deprecated