convertSexCodes: Converts sex indicator for an individual to a standardized...

View source: R/convertSexCodes.R

convertSexCodesR Documentation

Converts sex indicator for an individual to a standardized codes.

Description

Part of Pedigree Curation

Usage

convertSexCodes(sex, ignoreHerm = TRUE)

Arguments

sex

factor with levels: "M", "F", "U". Sex specifier for an individual.

ignoreHerm

logical flag indicating if hermaphrodites should be treated as unknown sex ("U"), default is TRUE.

Details

Standard sex codes are

  • {F} {– replacing "FEMALE" or "2"}

  • {M} {– replacing "MALE" or "1"}

  • {H} {– replacing "HERMAPHRODITE" or "4", if ignore.herm == FALSE}

  • {U} {– replacing "HERMAPHRODITE" or "4", if ignore.herm == TRUE}

  • {U} {– replacing "UNKNOWN" or "3"}

Value

A vector of factors representing standardized sex codes after transformation from non-standard codes.

Examples

library(nprcgenekeepr)
original <- c("m", "male", "1", "MALE", "M", "F", "f", "female",
              "FemAle", "U", "Unknown", "H", "hermaphrodite",
              "U", "Unknown", "3", "4")
sexCodes <- convertSexCodes(original)
sexCodes

rmsharp/nprcmanager documentation built on Feb. 2, 2025, 12:45 a.m.