sex_to_char: Convert integer sex codes to character codes

View source: R/sex_to_char.R

sex_to_charR Documentation

Convert integer sex codes to character codes

Description

This function accepts the integer sex codes accepted by Plink and turns them into the character codes accepted by Eigenstrat. Only upper-case characters are returned. Cases outside the table below are mapped to U (unknown) with a warning. The correspondence is:

  • 0: U (unknown)

  • 1: M (male)

  • 2: F (female)

Usage

sex_to_char(sex)

Arguments

sex

Integer vector of sex codes

Value

The converted character vector of sex codes

See Also

sex_to_int()

Eigenstrat IND format reference: https://github.com/DReichLab/EIG/tree/master/CONVERTF

Plink FAM format reference: https://www.cog-genomics.org/plink/1.9/formats#fam

Examples

# verify the mapping above
sex_int <- 0:2
sex_char <- c('U', 'M', 'F') # expected values
stopifnot(
  all(
    sex_to_char( sex_int ) == sex_char
  )
)


genio documentation built on Jan. 7, 2023, 1:12 a.m.