checkHaplotypeSyntax: Check haplotype syntax

View source: R/checkHaplotypeSyntax.R

checkHaplotypeSyntaxR Documentation

Check haplotype syntax

Description

Checks if alleles in a haplotype have correct syntax and an appropriate number of fields.

Usage

checkHaplotypeSyntax(haplotype, filename)

Arguments

haplotype

A haplotype where allele names are written in the IPD-IMGT/HLA Database format, and have 1-4 fields. Alleles in haplotypes must be delimited by "~".

filename

The full file path of the user specified dataset if the user wishes to use their own file, or pre-bundled mock haplotype dataset. User provided datasets must be a .dat, .txt, or.csv file, and must conform to the structure and format of the mock haplotype dataset bundled with the package.

Value

TRUE if all alleles in entered haplotype have correct syntax and appropriate number of fields. Otherwise, a vector containing FALSE and an error message is returned.

Note

For internal SSHAARP use only.


SSHAARP documentation built on June 18, 2025, 1:08 a.m.