Skip to content

Data utils

download_ld_matrix(target_dir='.', chromosome=None)

Download LD matrices for VIPRS software.

TODO: Update this once data is made available.

Parameters:

Name Type Description Default
target_dir

The path or directory where to store the LD matrix

 '.'
chromosome

An integer or list of integers with the chromosome numbers for which to download the LD matrices from Zenodo.

 None
Source code in viprs/utils/data_utils.py 
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
def download_ld_matrix(target_dir='.', chromosome=None):
    """
    Download LD matrices for VIPRS software.

    TODO: Update this once data is made available.

    :param target_dir: The path or directory where to store the LD matrix
    :param chromosome: An integer or list of integers with the chromosome numbers for which to download
    the LD matrices from Zenodo.
    """

    raise NotImplementedError("This function is not yet implemented.")