Learn R Programming

nprcgenekeepr (version 3.0.0)

getPossibleCols: Get possible column names for a studbook

Description

Pedigree curation function

Usage

getPossibleCols()

Arguments

Value

A character vector of the possible columns that can be in a studbook. The possible columns are as follows:

id

-- character vector with unique identifier for an individual

sire

-- character vector with unique identifier for an individual's father (NA if unknown).

dam

-- character vector with unique identifier for an individual's mother (NA if unknown).

sex

-- factor (levels: "M", "F", "U") Sex specifier for an individual

species

-- character vector or NA (optional) naming the species of the individual (e.g. "rhesus"). Recognized as a first-class column rather than retained as an unrecognized novel column.

gen

-- integer vector with the generation number of the individual

birth

-- Date or NA with the individual's birth date. This is one of the required columns (see getRequiredCols); the date value itself may be NA if unknown.

exit

-- Date or NA (optional) with the individual's exit date (death, or departure if applicable)

ancestry

-- character vector or NA (optional) that indicates the geographic population to which the individual belongs.

age

-- numeric or NA (optional) indicating the individual's current age or age at exit.

population

-- an optional logical argument indicating whether or not the id is part of the extant population.

origin

-- character vector or NA (optional) that indicates the name of the facility that the individual was imported from. NA indicates the individual was not imported.

status

-- an optional factor indicating the status of an individual with levels ALIVE, DECEASED, SHIPPED, and UNKNOWN.

condition

-- character vector or NA (optional) that indicates the restricted status of an animal. "Nonrestricted" animals are generally assumed to be naive.

spf

-- character vector or NA (optional) indicating the specific pathogen-free status of an individual.

vasxOvx

-- character vector indicating the vasectomy/ovariectomy status of an animal where NA indicates an intact animal and all other values indicate surgical alteration.

death

-- Date or NA (optional) with the individual's death date.

departure

-- Date or NA (optional) with the individual's departure date.

first

-- character vector or NA (optional) with the first value of a genotype pair. The name is reserved; genotype files may not use it.

second

-- character vector or NA (optional) with the second value of a genotype pair. The name is reserved; genotype files may not use it.

first_name

-- character vector or NA (optional) with the first value of a genotype pair in the single-locus genotype format.

second_name

-- character vector or NA (optional) with the second value of a genotype pair in the single-locus genotype format.

recordStatus

-- character vector with value "original" for records that were in the input and "added" for records added for parents that had no record of their own.

pedNum

-- integer vector indicating generation numbers for each id, starting at 0 for individuals lacking IDs for both parents.

affected

-- logical vector or NA (optional) indicating whether an individual is affected by a condition of interest, shaded on the Pedigree Diagram tab (issue #133). Matches kinship2's own affected argument naming/semantics; NA means unknown affected status, not "not affected".

name

-- character vector or NA (optional) giving a human-readable animal name/nickname, shown alongside id on the Pedigree Diagram tab when enabled (issue #136). NA or an empty string falls back to id; not all centers record this field, so its presence and completeness both vary by animal. Scrubbed to NA by obfuscatePed.

Examples

Run this code
library(nprcgenekeepr)
getPossibleCols()

Run the code above in your browser using DataLab