check_alleles: Check the allele names

View source: R/check_alleles.R

check_allelesR Documentation

Check the allele names

Description

Check if the alleles have a valid NetMHC2pan name. Will stop if not.

Usage

check_alleles(
  alleles,
  netmhc2pan_folder_name = get_default_netmhc2pan_folder()
)

Arguments

alleles

one or more alleles, e.g. DRB1_0101. See get_netmhc2pan_alleles for a full list

netmhc2pan_folder_name

the folder (to be) used by NetMHCIIpan. From this location, a subfolder for NetMHCIIpan is created. Use get_default_netmhc2pan_folder to see the location of the default NetMHCIIpan folder. Use get_default_netmhc2pan_subfolder to see the location of the default NetMHCIIpan subfolder.

Value

nothing

Author(s)

Richèl J.C. Bilderbeek

See Also

Use to_netmhc2pan_name to convert a formal name to an NetMHC2pan name. Use get_netmhc2pan_alleles for a list of all supported alleles (in NetMHC2pan naming format).

Examples

if (is_netmhc2pan_installed()) {
  check_alleles("DRB1_0101")
  check_alleles(c("DRB1_0102", "DRB1_0103"))
}

netmhc2pan documentation built on Nov. 9, 2023, 1:08 a.m.