readKinshipOverrides: Read a kinship overrides table from a file

In nprcgenekeepr: Genetic Tools for Colony Management

Read a kinship overrides table from a file

Description

Reads an outside-information kinship override table from a user-supplied file into a data frame for checkKinshipOverrides and reportGV. The expected long form is the output of kinMatrix2LongForm: columns id1, id2, and kinship, with a header row, so a user can export the current matrix, edit a few rows, and feed it back. Excel (.xls/.xlsx) and delimited text (.csv/.txt) files are both accepted, mirroring getGenotypes.

Usage

readKinshipOverrides(fileName, sep = ",")

Arguments

fileName	character vector of length one; path to the override file (typically the temporary datapath from a Shiny file upload).
sep	column separator for delimited text files (default ",").

Details

This reader does not validate structure or domain – that is checkKinshipOverrides's job. kinship is the kinship coefficient f, not the coefficient of relatedness r (= 2f for non-inbred animals).

Value

A data frame of the rows read from fileName (typically with columns id1, id2, and kinship). Validate it with checkKinshipOverrides before use.

Examples

## Not run: 
overrides <- readKinshipOverrides(fileName = "kinship_overrides.csv")
overrides <- checkKinshipOverrides(overrides)

## End(Not run)

nprcgenekeepr documentation built on July 26, 2026, 5:06 p.m.