API

gedmatch_tools.api.add(genotypes: pathlib.Path, name: str, raw_data_type: Optional[gedmatch_tools.util.RawDataType] = None, fam: Optional[pathlib.Path] = None) → gedmatch_tools.util.Kit

Performs a generic upload of the given genotype.

The sample information when given will be used to determine the sex of the donor, otherwise it will default to female.

Parameters:
  • genotypes – the path to the genotype file.
  • name – the name of the donor.
  • raw_data_type – optionally the raw data type to select.
  • fam – optionally a PLINK sample information file; see the following link https://www.cog-genomics.org/plink2/formats#fam
Returns:

the kit created by GEDMatch
Raises:

Exception – if the kit could not be uploaded
gedmatch_tools.api.ls(driver: Optional[selenium.webdriver.remote.webdriver.WebDriver] = None, status: Optional[List[gedmatch_tools.util.KitStatus]] = None) → List[gedmatch_tools.util.Kit]

Returns the the kits available on GEDMatch.com

Parameters:status – return only kits with the given status(es)
gedmatch_tools.api.one_to_many(kit: str, output: pathlib.Path, max_matches: Optional[int], kits: Optional[Dict[str, gedmatch_tools.util.Kit]] = None, driver: Optional[selenium.webdriver.remote.webdriver.WebDriver] = None) → List[gedmatch_tools.api._one_to_many.OneToManyAutosomeResult]

Performs one-to-many autosomal analysis.

Parameters:
  • kit – the name or number
  • output – the output file.
  • max_matches – the maximum # of matches to return
  • kits – a mapping of kit name to kit, useful when performing many 1:1 analyses.
Returns:

A list of matches.
gedmatch_tools.api.one_to_one(kit_one: str, kit_two: str, output_prefix: pathlib.Path, kits: Optional[Dict[str, gedmatch_tools.util.Kit]] = None, driver: Optional[selenium.webdriver.remote.webdriver.WebDriver] = None) → Optional[gedmatch_tools.api._one_to_one.OneToOneAutosomeResult]

Performs one-to-one autosomal analysis.

Parameters:
  • kit_one – the first kit name or number
  • kit_two – the second kit name or number
  • output_prefix – the prefix for the output files.
  • kits – a mapping of kit name to kit, useful when performing many 1:1 analyses.
Returns:

None if the analysis did not find any segments, otherwise the analysis results.
gedmatch_tools.api.rm(*number) → None

Removes the kit(s) with the given number(s).

gedmatch_tools.api.rm_r() → None

Removes all kits on the GEDMatch website.