Skip to content

Sumstats parsers

COJOSSParser

Bases: SumstatsParser

A specialized class for parsing GWAS summary statistics files generated by the COJO software.

See Also

Attributes:

Name Type Description
col_name_converter

A dictionary mapping column names in the original table to magenpy's column names.
read_csv_kwargs

Keyword arguments to pass to pandas' read_csv.
Source code in magenpy/parsers/sumstats_parsers.py 
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
class COJOSSParser(SumstatsParser):
    """
    A specialized class for parsing GWAS summary statistics files generated by the `COJO` software.

    !!! seealso "See Also"
        * [Plink2SSParser][magenpy.parsers.sumstats_parsers.Plink2SSParser]
        * [Plink1SSParser][magenpy.parsers.sumstats_parsers.Plink1SSParser]
        * [FastGWASSParser][magenpy.parsers.sumstats_parsers.FastGWASSParser]
        * [SSFParser][magenpy.parsers.sumstats_parsers.SSFParser]
        * [SaigeSSParser][magenpy.parsers.sumstats_parsers.SaigeSSParser]

    :ivar col_name_converter: A dictionary mapping column names in the original table to magenpy's column names.
    :ivar read_csv_kwargs: Keyword arguments to pass to pandas' `read_csv`.
    """

    def __init__(self, col_name_converter=None, **read_csv_kwargs):
        """

        Initialize the COJO summary statistics parser.

        :param col_name_converter: A dictionary/string mapping column names
        in the original table to magenpy's column names for the various
        summary statistics. If a string, it should be a comma-separated list of
        key-value pairs (e.g. 'rsid=SNP,pos=POS').
        :param read_csv_kwargs: Keyword arguments to pass to pandas' read_csv
        """
        super().__init__(col_name_converter, **read_csv_kwargs)

        self.col_name_converter = self.col_name_converter or {}

        self.col_name_converter.update(
            {
                'freq': 'MAF',
                'b': 'BETA',
                'se': 'SE',
                'p': 'PVAL'
            }
        )

__init__(col_name_converter=None, **read_csv_kwargs)

Initialize the COJO summary statistics parser.

Parameters:

Name Type Description Default
col_name_converter

A dictionary/string mapping column names in the original table to magenpy's column names for the various summary statistics. If a string, it should be a comma-separated list of key-value pairs (e.g. 'rsid=SNP,pos=POS').

 None
read_csv_kwargs

Keyword arguments to pass to pandas' read_csv

 {}
Source code in magenpy/parsers/sumstats_parsers.py 
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
def __init__(self, col_name_converter=None, **read_csv_kwargs):
    """

    Initialize the COJO summary statistics parser.

    :param col_name_converter: A dictionary/string mapping column names
    in the original table to magenpy's column names for the various
    summary statistics. If a string, it should be a comma-separated list of
    key-value pairs (e.g. 'rsid=SNP,pos=POS').
    :param read_csv_kwargs: Keyword arguments to pass to pandas' read_csv
    """
    super().__init__(col_name_converter, **read_csv_kwargs)

    self.col_name_converter = self.col_name_converter or {}

    self.col_name_converter.update(
        {
            'freq': 'MAF',
            'b': 'BETA',
            'se': 'SE',
            'p': 'PVAL'
        }
    )

FastGWASSParser

Bases: SumstatsParser

A specialized class for parsing GWAS summary statistics files generated by the FastGWA software.

See Also

Attributes:

Name Type Description
col_name_converter

A dictionary mapping column names in the original table to magenpy's column names.
read_csv_kwargs

Keyword arguments to pass to pandas' read_csv.
Source code in magenpy/parsers/sumstats_parsers.py 
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
class FastGWASSParser(SumstatsParser):
    """
    A specialized class for parsing GWAS summary statistics files generated by the `FastGWA` software.

    !!! seealso "See Also"
        * [Plink2SSParser][magenpy.parsers.sumstats_parsers.Plink2SSParser]
        * [Plink1SSParser][magenpy.parsers.sumstats_parsers.Plink1SSParser]
        * [COJOSSParser][magenpy.parsers.sumstats_parsers.COJOSSParser]
        * [SSFParser][magenpy.parsers.sumstats_parsers.SSFParser]
        * [SaigeSSParser][magenpy.parsers.sumstats_parsers.SaigeSSParser]

    :ivar col_name_converter: A dictionary mapping column names in the original table to magenpy's column names.
    :ivar read_csv_kwargs: Keyword arguments to pass to pandas' `read_csv`.


    """

    def __init__(self, col_name_converter=None, **read_csv_kwargs):
        """
        :param col_name_converter: A dictionary/string mapping column names
        in the original table to magenpy's column names for the various
        summary statistics. If a string, it should be a comma-separated list of
        key-value pairs (e.g. 'rsid=SNP,pos=POS').
        :param read_csv_kwargs: Keyword arguments to pass to pandas' read_csv
        """
        super().__init__(col_name_converter, **read_csv_kwargs)

        self.col_name_converter = self.col_name_converter or {}

        self.col_name_converter.update(
            {
                'AF1': 'MAF',
                'P': 'PVAL'
            }
        )

__init__(col_name_converter=None, **read_csv_kwargs)

Parameters:

Name Type Description Default
col_name_converter

A dictionary/string mapping column names in the original table to magenpy's column names for the various summary statistics. If a string, it should be a comma-separated list of key-value pairs (e.g. 'rsid=SNP,pos=POS').

 None
read_csv_kwargs

Keyword arguments to pass to pandas' read_csv

 {}
Source code in magenpy/parsers/sumstats_parsers.py 
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
def __init__(self, col_name_converter=None, **read_csv_kwargs):
    """
    :param col_name_converter: A dictionary/string mapping column names
    in the original table to magenpy's column names for the various
    summary statistics. If a string, it should be a comma-separated list of
    key-value pairs (e.g. 'rsid=SNP,pos=POS').
    :param read_csv_kwargs: Keyword arguments to pass to pandas' read_csv
    """
    super().__init__(col_name_converter, **read_csv_kwargs)

    self.col_name_converter = self.col_name_converter or {}

    self.col_name_converter.update(
        {
            'AF1': 'MAF',
            'P': 'PVAL'
        }
    )

Plink1SSParser

Bases: SumstatsParser

A specialized class for parsing GWAS summary statistics files generated by plink1.9.

See Also

Attributes:

Name Type Description
col_name_converter

A dictionary mapping column names in the original table to magenpy's column names.
read_csv_kwargs

Keyword arguments to pass to pandas' read_csv.
Source code in magenpy/parsers/sumstats_parsers.py 
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
class Plink1SSParser(SumstatsParser):
    """
    A specialized class for parsing GWAS summary statistics files generated by `plink1.9`.

    !!! seealso "See Also"
        * [Plink2SSParser][magenpy.parsers.sumstats_parsers.Plink2SSParser]
        * [COJOSSParser][magenpy.parsers.sumstats_parsers.COJOSSParser]
        * [FastGWASSParser][magenpy.parsers.sumstats_parsers.FastGWASSParser]
        * [SSFParser][magenpy.parsers.sumstats_parsers.SSFParser]
        * [SaigeSSParser][magenpy.parsers.sumstats_parsers.SaigeSSParser]

    :ivar col_name_converter: A dictionary mapping column names in the original table to magenpy's column names.
    :ivar read_csv_kwargs: Keyword arguments to pass to pandas' `read_csv`.

    """

    def __init__(self, col_name_converter=None, **read_csv_kwargs):
        """
        Initialize the `plink1.9` summary statistics parser.

        :param col_name_converter: A dictionary/string mapping column names
        in the original table to magenpy's column names for the various
        summary statistics. If a string, it should be a comma-separated list of
        key-value pairs (e.g. 'rsid=SNP,pos=POS').
        :param read_csv_kwargs: Keyword arguments to pass to pandas' read_csv
        """

        super().__init__(col_name_converter, **read_csv_kwargs)

        self.col_name_converter = self.col_name_converter or {}

        self.col_name_converter.update(
            {
                'P': 'PVAL',
                'NMISS': 'N',
                'STAT': 'Z',
                'BP': 'POS'
            }
        )

__init__(col_name_converter=None, **read_csv_kwargs)

Initialize the plink1.9 summary statistics parser.

Parameters:

Name Type Description Default
col_name_converter

A dictionary/string mapping column names in the original table to magenpy's column names for the various summary statistics. If a string, it should be a comma-separated list of key-value pairs (e.g. 'rsid=SNP,pos=POS').

 None
read_csv_kwargs

Keyword arguments to pass to pandas' read_csv

 {}
Source code in magenpy/parsers/sumstats_parsers.py 
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
def __init__(self, col_name_converter=None, **read_csv_kwargs):
    """
    Initialize the `plink1.9` summary statistics parser.

    :param col_name_converter: A dictionary/string mapping column names
    in the original table to magenpy's column names for the various
    summary statistics. If a string, it should be a comma-separated list of
    key-value pairs (e.g. 'rsid=SNP,pos=POS').
    :param read_csv_kwargs: Keyword arguments to pass to pandas' read_csv
    """

    super().__init__(col_name_converter, **read_csv_kwargs)

    self.col_name_converter = self.col_name_converter or {}

    self.col_name_converter.update(
        {
            'P': 'PVAL',
            'NMISS': 'N',
            'STAT': 'Z',
            'BP': 'POS'
        }
    )

Plink2SSParser

Bases: SumstatsParser

A specialized class for parsing GWAS summary statistics files generated by plink2.

See Also

Attributes:

Name Type Description
col_name_converter

A dictionary mapping column names in the original table to magenpy's column names.
read_csv_kwargs

Keyword arguments to pass to pandas' read_csv.
Source code in magenpy/parsers/sumstats_parsers.py 
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
class Plink2SSParser(SumstatsParser):
    """
    A specialized class for parsing GWAS summary statistics files generated by `plink2`.

    !!! seealso "See Also"
        * [Plink1SSParser][magenpy.parsers.sumstats_parsers.Plink1SSParser]
        * [COJOSSParser][magenpy.parsers.sumstats_parsers.COJOSSParser]
        * [FastGWASSParser][magenpy.parsers.sumstats_parsers.FastGWASSParser]
        * [SSFParser][magenpy.parsers.sumstats_parsers.SSFParser]
        * [SaigeSSParser][magenpy.parsers.sumstats_parsers.SaigeSSParser]

    :ivar col_name_converter: A dictionary mapping column names in the original table to magenpy's column names.
    :ivar read_csv_kwargs: Keyword arguments to pass to pandas' `read_csv`.

    """

    def __init__(self, col_name_converter=None, **read_csv_kwargs):
        """

        Initialize the `plink2` summary statistics parser.

        :param col_name_converter: A dictionary/string mapping column names
        in the original table to magenpy's column names for the various
        summary statistics. If a string, it should be a comma-separated list of
        key-value pairs (e.g. 'rsid=SNP,pos=POS').
        :param read_csv_kwargs: Keyword arguments to pass to pandas' read_csv
        """

        super().__init__(col_name_converter, **read_csv_kwargs)

        self.col_name_converter = self.col_name_converter or {}

        self.col_name_converter.update(
            {
                '#CHROM': 'CHR',
                'ID': 'SNP',
                'P': 'PVAL',
                'OBS_CT': 'N',
                'A1_FREQ': 'MAF',
                'T_STAT': 'Z',
                'Z_STAT': 'Z'
            }
        )

    def parse(self, file_name, drop_na=True):
        """
        Parse a summary statistics file.
        :param file_name: The path to the summary statistics file.
        :param drop_na: Drop any entries with missing values.

        :return: A pandas DataFrame containing the parsed summary statistics.
        """

        df = super().parse(file_name, drop_na=drop_na)

        if 'A2' not in df.columns:
            try:
                if 'ALT1' in df.columns:
                    df['A2'] = np.where(df['A1'] == df['ALT1'], df['REF'], df['ALT1'])
                elif 'ALT' in df.columns:
                    df['A2'] = np.where(df['A1'] == df['ALT'], df['REF'], df['ALT'])
                else:
                    warnings.warn("The reference allele A2 could not be inferred "
                                  "from the summary statistics file!")
            except KeyError:
                warnings.warn("The reference allele A2 could not be inferred "
                              "from the summary statistics file! Some of the columns needed to infer "
                              "the A2 allele are missing or coded differently than what we expect.")

        return df

__init__(col_name_converter=None, **read_csv_kwargs)

Initialize the plink2 summary statistics parser.

Parameters:

Name Type Description Default
col_name_converter

A dictionary/string mapping column names in the original table to magenpy's column names for the various summary statistics. If a string, it should be a comma-separated list of key-value pairs (e.g. 'rsid=SNP,pos=POS').

 None
read_csv_kwargs

Keyword arguments to pass to pandas' read_csv

 {}
Source code in magenpy/parsers/sumstats_parsers.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def __init__(self, col_name_converter=None, **read_csv_kwargs):
    """

    Initialize the `plink2` summary statistics parser.

    :param col_name_converter: A dictionary/string mapping column names
    in the original table to magenpy's column names for the various
    summary statistics. If a string, it should be a comma-separated list of
    key-value pairs (e.g. 'rsid=SNP,pos=POS').
    :param read_csv_kwargs: Keyword arguments to pass to pandas' read_csv
    """

    super().__init__(col_name_converter, **read_csv_kwargs)

    self.col_name_converter = self.col_name_converter or {}

    self.col_name_converter.update(
        {
            '#CHROM': 'CHR',
            'ID': 'SNP',
            'P': 'PVAL',
            'OBS_CT': 'N',
            'A1_FREQ': 'MAF',
            'T_STAT': 'Z',
            'Z_STAT': 'Z'
        }
    )

parse(file_name, drop_na=True)

Parse a summary statistics file.

Parameters:

Name Type Description Default
file_name

The path to the summary statistics file.

 required
drop_na

Drop any entries with missing values.

 True

Returns:

Type Description

A pandas DataFrame containing the parsed summary statistics.
Source code in magenpy/parsers/sumstats_parsers.py 
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
def parse(self, file_name, drop_na=True):
    """
    Parse a summary statistics file.
    :param file_name: The path to the summary statistics file.
    :param drop_na: Drop any entries with missing values.

    :return: A pandas DataFrame containing the parsed summary statistics.
    """

    df = super().parse(file_name, drop_na=drop_na)

    if 'A2' not in df.columns:
        try:
            if 'ALT1' in df.columns:
                df['A2'] = np.where(df['A1'] == df['ALT1'], df['REF'], df['ALT1'])
            elif 'ALT' in df.columns:
                df['A2'] = np.where(df['A1'] == df['ALT'], df['REF'], df['ALT'])
            else:
                warnings.warn("The reference allele A2 could not be inferred "
                              "from the summary statistics file!")
        except KeyError:
            warnings.warn("The reference allele A2 could not be inferred "
                          "from the summary statistics file! Some of the columns needed to infer "
                          "the A2 allele are missing or coded differently than what we expect.")

    return df

SSFParser

Bases: SumstatsParser

A specialized class for parsing GWAS summary statistics that are formatted according to the standardized summary statistics format adopted by the GWAS Catalog. This format is sometimes denoted as GWAS-SSF.

Reference and details: https://github.com/EBISPOT/gwas-summary-statistics-standard

See Also

Attributes:

Name Type Description
col_name_converter

A dictionary mapping column names in the original table to magenpy's column names.
read_csv_kwargs

Keyword arguments to pass to pandas' read_csv.
Source code in magenpy/parsers/sumstats_parsers.py 
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
class SSFParser(SumstatsParser):
    """
    A specialized class for parsing GWAS summary statistics that are formatted according
     to the standardized summary statistics format adopted by the GWAS Catalog. This format is
     sometimes denoted as `GWAS-SSF`.

    Reference and details:
    https://github.com/EBISPOT/gwas-summary-statistics-standard

    !!! seealso "See Also"
        * [Plink2SSParser][magenpy.parsers.sumstats_parsers.Plink2SSParser]
        * [Plink1SSParser][magenpy.parsers.sumstats_parsers.Plink1SSParser]
        * [COJOSSParser][magenpy.parsers.sumstats_parsers.COJOSSParser]
        * [FastGWASSParser][magenpy.parsers.sumstats_parsers.FastGWASSParser]
        * [SaigeSSParser][magenpy.parsers.sumstats_parsers.SaigeSSParser]

    :ivar col_name_converter: A dictionary mapping column names in the original table to magenpy's column names.
    :ivar read_csv_kwargs: Keyword arguments to pass to pandas' `read_csv`.

    """

    def __init__(self, col_name_converter=None, **read_csv_kwargs):
        """

        Initialize the standardized summary statistics parser.

        :param col_name_converter: A dictionary/string mapping column names
        in the original table to magenpy's column names for the various
        summary statistics. If a string, it should be a comma-separated list of
        key-value pairs (e.g. 'rsid=SNP,pos=POS').
        :param read_csv_kwargs: Keyword arguments to pass to pandas' read_csv
        """

        super().__init__(col_name_converter, **read_csv_kwargs)

        self.col_name_converter = self.col_name_converter or {}

        self.col_name_converter.update(
            {
                'chromosome': 'CHR',
                'base_pair_location': 'POS',
                'rsid': 'SNP',
                'effect_allele': 'A1',
                'other_allele': 'A2',
                'beta': 'BETA',
                'standard_error': 'SE',
                'effect_allele_frequency': 'MAF',
                'p_value': 'PVAL',
                'n': 'N'
            }
        )

__init__(col_name_converter=None, **read_csv_kwargs)

Initialize the standardized summary statistics parser.

Parameters:

Name Type Description Default
col_name_converter

A dictionary/string mapping column names in the original table to magenpy's column names for the various summary statistics. If a string, it should be a comma-separated list of key-value pairs (e.g. 'rsid=SNP,pos=POS').

 None
read_csv_kwargs

Keyword arguments to pass to pandas' read_csv

 {}
Source code in magenpy/parsers/sumstats_parsers.py 
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
def __init__(self, col_name_converter=None, **read_csv_kwargs):
    """

    Initialize the standardized summary statistics parser.

    :param col_name_converter: A dictionary/string mapping column names
    in the original table to magenpy's column names for the various
    summary statistics. If a string, it should be a comma-separated list of
    key-value pairs (e.g. 'rsid=SNP,pos=POS').
    :param read_csv_kwargs: Keyword arguments to pass to pandas' read_csv
    """

    super().__init__(col_name_converter, **read_csv_kwargs)

    self.col_name_converter = self.col_name_converter or {}

    self.col_name_converter.update(
        {
            'chromosome': 'CHR',
            'base_pair_location': 'POS',
            'rsid': 'SNP',
            'effect_allele': 'A1',
            'other_allele': 'A2',
            'beta': 'BETA',
            'standard_error': 'SE',
            'effect_allele_frequency': 'MAF',
            'p_value': 'PVAL',
            'n': 'N'
        }
    )

SaigeSSParser

Bases: SumstatsParser

A specialized class for parsing GWAS summary statistics files generated by the SAIGE software. Reference and details: https://saigegit.github.io/SAIGE-doc/docs/single_step2.html

TODO: Ensure that the column names are correct across different trait types and the inference of the sample size is correct.

See Also

Attributes:

Name Type Description
col_name_converter

A dictionary mapping column names in the original table to magenpy's column names.
read_csv_kwargs

Keyword arguments to pass to pandas' read_csv.
Source code in magenpy/parsers/sumstats_parsers.py 
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
class SaigeSSParser(SumstatsParser):
    """
    A specialized class for parsing GWAS summary statistics files generated by the `SAIGE` software.
    Reference and details:
    https://saigegit.github.io/SAIGE-doc/docs/single_step2.html

    TODO: Ensure that the column names are correct across different trait types
    and the inference of the sample size is correct.

    !!! seealso "See Also"
        * [Plink2SSParser][magenpy.parsers.sumstats_parsers.Plink2SSParser]
        * [Plink1SSParser][magenpy.parsers.sumstats_parsers.Plink1SSParser]
        * [COJOSSParser][magenpy.parsers.sumstats_parsers.COJOSSParser]
        * [FastGWASSParser][magenpy.parsers.sumstats_parsers.FastGWASSParser]
        * [SSFParser][magenpy.parsers.sumstats_parsers.SSFParser]

    :ivar col_name_converter: A dictionary mapping column names in the original table to magenpy's column names.
    :ivar read_csv_kwargs: Keyword arguments to pass to pandas' `read_csv`.

    """

    def __init__(self, col_name_converter=None, **read_csv_kwargs):
        """
        Initialize the `SAIGE` summary statistics parser.

        :param col_name_converter: A dictionary/string mapping column names
        in the original table to magenpy's column names for the various
        summary statistics. If a string, it should be a comma-separated list of
        key-value pairs (e.g. 'rsid=SNP,pos=POS').
        :param read_csv_kwargs: Keyword arguments to pass to pandas' read_csv
        """
        super().__init__(col_name_converter, **read_csv_kwargs)

        self.col_name_converter = self.col_name_converter or {}

        # NOTE: SAIGE considers Allele2 to be the effect allele, so
        # we switch their designation here:
        self.col_name_converter.update(
            {
                'MarkerID': 'SNP',
                'Allele1': 'A2',
                'Allele2': 'A1',
                'AF_Allele2': 'MAF',
                'AC_Allele2': 'MAC',
                'Tstat': 'Z',
                'p.value': 'PVAL',
            }
        )

    def parse(self, file_name, drop_na=True):
        """
        Parse the summary statistics file.
        :param file_name: The path to the summary statistics file.
        :param drop_na: Drop any entries with missing values.

        :return: A pandas DataFrame containing the parsed summary statistics.
        """

        df = super().parse(file_name, drop_na=drop_na)

        # Infer the sample size N
        df['N'] = df['MAC'] / (2.*df['MAF'])

        return df

__init__(col_name_converter=None, **read_csv_kwargs)

Initialize the SAIGE summary statistics parser.

Parameters:

Name Type Description Default
col_name_converter

A dictionary/string mapping column names in the original table to magenpy's column names for the various summary statistics. If a string, it should be a comma-separated list of key-value pairs (e.g. 'rsid=SNP,pos=POS').

 None
read_csv_kwargs

Keyword arguments to pass to pandas' read_csv

 {}
Source code in magenpy/parsers/sumstats_parsers.py 
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
def __init__(self, col_name_converter=None, **read_csv_kwargs):
    """
    Initialize the `SAIGE` summary statistics parser.

    :param col_name_converter: A dictionary/string mapping column names
    in the original table to magenpy's column names for the various
    summary statistics. If a string, it should be a comma-separated list of
    key-value pairs (e.g. 'rsid=SNP,pos=POS').
    :param read_csv_kwargs: Keyword arguments to pass to pandas' read_csv
    """
    super().__init__(col_name_converter, **read_csv_kwargs)

    self.col_name_converter = self.col_name_converter or {}

    # NOTE: SAIGE considers Allele2 to be the effect allele, so
    # we switch their designation here:
    self.col_name_converter.update(
        {
            'MarkerID': 'SNP',
            'Allele1': 'A2',
            'Allele2': 'A1',
            'AF_Allele2': 'MAF',
            'AC_Allele2': 'MAC',
            'Tstat': 'Z',
            'p.value': 'PVAL',
        }
    )

parse(file_name, drop_na=True)

Parse the summary statistics file.

Parameters:

Name Type Description Default
file_name

The path to the summary statistics file.

 required
drop_na

Drop any entries with missing values.

 True

Returns:

Type Description

A pandas DataFrame containing the parsed summary statistics.
Source code in magenpy/parsers/sumstats_parsers.py 
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
def parse(self, file_name, drop_na=True):
    """
    Parse the summary statistics file.
    :param file_name: The path to the summary statistics file.
    :param drop_na: Drop any entries with missing values.

    :return: A pandas DataFrame containing the parsed summary statistics.
    """

    df = super().parse(file_name, drop_na=drop_na)

    # Infer the sample size N
    df['N'] = df['MAC'] / (2.*df['MAF'])

    return df

SumstatsParser

Bases: object

A wrapper class for parsing summary statistics files that are written by statistical genetics software for Genome-wide Association testing. A common challenge is the fact that different software tools output summary statistics in different formats and with different column names. Thus, this class provides a common interface for parsing summary statistics files from different software tools and aims to make this process as seamless as possible.

The class is designed to be extensible, so that users can easily add new parsers for different software tools.

See Also

Attributes:

Name Type Description
col_name_converter

A dictionary mapping column names in the original table to magenpy's column names.
read_csv_kwargs

Keyword arguments to pass to pandas' read_csv.
Source code in magenpy/parsers/sumstats_parsers.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
class SumstatsParser(object):
    """
    A wrapper class for parsing summary statistics files that are written by statistical genetics software
    for Genome-wide Association testing. A common challenge is the fact that different software tools
    output summary statistics in different formats and with different column names. Thus, this class
    provides a common interface for parsing summary statistics files from different software tools
    and aims to make this process as seamless as possible.

    The class is designed to be extensible, so that users can easily add new parsers for different software tools.

    !!! seealso "See Also"
        * [Plink2SSParser][magenpy.parsers.sumstats_parsers.Plink2SSParser]
        * [Plink1SSParser][magenpy.parsers.sumstats_parsers.Plink1SSParser]
        * [COJOSSParser][magenpy.parsers.sumstats_parsers.COJOSSParser]
        * [FastGWASSParser][magenpy.parsers.sumstats_parsers.FastGWASSParser]
        * [SSFParser][magenpy.parsers.sumstats_parsers.SSFParser]
        * [SaigeSSParser][magenpy.parsers.sumstats_parsers.SaigeSSParser]

    :ivar col_name_converter: A dictionary mapping column names in the original table to magenpy's column names.
    :ivar read_csv_kwargs: Keyword arguments to pass to pandas' `read_csv`.

    """

    def __init__(self, col_name_converter=None, **read_csv_kwargs):
        """
        Initialize the summary statistics parser.

        :param col_name_converter: A dictionary/string mapping column names
        in the original table to magenpy's column names for the various
        summary statistics. If a string, it should be a comma-separated list of
        key-value pairs (e.g. 'rsid=SNP,pos=POS').
        :param read_csv_kwargs: Keyword arguments to pass to pandas' read_csv
        """

        if isinstance(col_name_converter, str):
            self.col_name_converter = {
                k: v for entry in col_name_converter.split(',') for k, v in [entry.strip().split('=')]
                if len(entry.strip()) > 0
            }
        else:
            self.col_name_converter = col_name_converter

        self.read_csv_kwargs = read_csv_kwargs

        # If the delimiter is not specified, assume whitespace by default:
        if 'sep' not in self.read_csv_kwargs and 'delimiter' not in self.read_csv_kwargs:
            self.read_csv_kwargs['sep'] = r'\s+'

    def parse(self, file_name, drop_na=True):
        """
        Parse a summary statistics file.
        :param file_name: The path to the summary statistics file.
        :param drop_na: If True, drop any entries with missing values.

        :return: A pandas DataFrame containing the parsed summary statistics.
        """

        df = pd.read_csv(file_name, **self.read_csv_kwargs)

        if drop_na:
            df = df.dropna()

        if self.col_name_converter is not None:
            df.rename(columns=self.col_name_converter, inplace=True)

        try:
            df['POS'] = df['POS'].astype(np.int32)
        except KeyError:
            pass

        return df

__init__(col_name_converter=None, **read_csv_kwargs)

Initialize the summary statistics parser.

Parameters:

Name Type Description Default
col_name_converter

A dictionary/string mapping column names in the original table to magenpy's column names for the various summary statistics. If a string, it should be a comma-separated list of key-value pairs (e.g. 'rsid=SNP,pos=POS').

 None
read_csv_kwargs

Keyword arguments to pass to pandas' read_csv

 {}
Source code in magenpy/parsers/sumstats_parsers.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
def __init__(self, col_name_converter=None, **read_csv_kwargs):
    """
    Initialize the summary statistics parser.

    :param col_name_converter: A dictionary/string mapping column names
    in the original table to magenpy's column names for the various
    summary statistics. If a string, it should be a comma-separated list of
    key-value pairs (e.g. 'rsid=SNP,pos=POS').
    :param read_csv_kwargs: Keyword arguments to pass to pandas' read_csv
    """

    if isinstance(col_name_converter, str):
        self.col_name_converter = {
            k: v for entry in col_name_converter.split(',') for k, v in [entry.strip().split('=')]
            if len(entry.strip()) > 0
        }
    else:
        self.col_name_converter = col_name_converter

    self.read_csv_kwargs = read_csv_kwargs

    # If the delimiter is not specified, assume whitespace by default:
    if 'sep' not in self.read_csv_kwargs and 'delimiter' not in self.read_csv_kwargs:
        self.read_csv_kwargs['sep'] = r'\s+'

parse(file_name, drop_na=True)

Parse a summary statistics file.

Parameters:

Name Type Description Default
file_name

The path to the summary statistics file.

 required
drop_na

If True, drop any entries with missing values.

 True

Returns:

Type Description

A pandas DataFrame containing the parsed summary statistics.
Source code in magenpy/parsers/sumstats_parsers.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
def parse(self, file_name, drop_na=True):
    """
    Parse a summary statistics file.
    :param file_name: The path to the summary statistics file.
    :param drop_na: If True, drop any entries with missing values.

    :return: A pandas DataFrame containing the parsed summary statistics.
    """

    df = pd.read_csv(file_name, **self.read_csv_kwargs)

    if drop_na:
        df = df.dropna()

    if self.col_name_converter is not None:
        df.rename(columns=self.col_name_converter, inplace=True)

    try:
        df['POS'] = df['POS'].astype(np.int32)
    except KeyError:
        pass

    return df