query_haplotype_frequencies: Query haplotype frequencies

View source: R/AFND_queries.R

query_haplotype_frequenciesR Documentation

Query haplotype frequencies

Description

Query haplotype frequencies

Usage

query_haplotype_frequencies(
  hla_selection = NA,
  hla_population = NA,
  hla_country = NA,
  hla_region = NA,
  hla_ethnic = NA,
  hla_sample_size_pattern = NA,
  hla_sample_size = NA
)

Arguments

hla_selection

Alleles that will be used to build the haplotype query. One entry per locus. If no entry for a given locus, the function will search for haplotypes that do not include specifications for this locus. If any allele for a given locus should be considered, the list entry should be "A*" or other locus in same format.

hla_population

Numeric identifier of the population that will be used for filtering. Thie identifier is defined by the Allele Frequency Net Database.

hla_country

Country of interest (e.g. Germany, France, ...).

hla_region

Geographic region of interest (e.g. Europe, North Africa, ...)

hla_ethnic

Ethnic origin of interest (e.g. Caucasoid, Siberian, ...)

hla_sample_size_pattern

Keyword used to define the filtering for a specific population size. e.g. "bigger_than", "equal", "less_than", "less_equal_than", "bigger_equal_than"

hla_sample_size

Integer number used to define the filtering for a specific population size, together with the hla_sample_size_pattern argument.

Value

data.frame object containing the result of the allele frequency query

Examples

# works only for one haplotype at a time
query_haplotype_frequencies(hla_selection = c("A*02:01", "B*", "C*"), 
hla_region = "Europe")


imkeller/immunotation documentation built on Jan. 3, 2023, 1:31 p.m.