Skip to main content

Various tools and scripts used in the GHFC lab

Project description

ghfc-utils

set of small tools designed to help automatize simple task locally or on Pasteur's cluster.

  • ghfc-reannotate for the postprocessing of slivar files including filtering and geneset reannotation.

Installation

pip install ghfc-utils

PS. on maestro, do not forget to load Python first (not needed anymore once installed):

module load Python/3.9.16

slivar reannotator

A tool to filter and reannotate slivar files according to various parameters and genesets. The goal is to produce a more generic kind of slivar files and to use this for the user to run their own filtering. ghfc-reannotate reads a slivar file and given a config file, will return an annotated and filtered slivar file.

usage: ghfc-reannotate [-h] configuration slivar output

positional arguments:
  configuration         config file
  slivar                slivar file to reannotate
  output                annotated slivar file

optional arguments:
  -h, --help            show this help message and exit
  --chunksize CHUNKSIZE
                        size of the chunks read from the input (default 100000)
  -k, --keep-all-transcripts
                        to keep all impacted transcript instead of the first

Example

You need to prepare a config file or take the one provided here. Then, you need a slivar file to run the tool on. For instance you can use the 570MB file at /pasteur/zeus/projets/p02/ghfc_wgs_zeus/WGS/Paris-AIMS2/slivar/Paris-AIMS2.slivar-full.lof_miss.tsv on zeus.

ghfc-reannotate config.yaml input_slivar.tsv output_slivar.tsv

The provided config file has a lot of comments to help build a new one.

how is it working?

  • This tools read the slivar file before decomposing the impacts by transcripts (so 1 line per trancsript).
    • as slivar files can be really large in some project, the reading is done by chinks of 100k rows.
  • Then, it filters all lines using, in this order following the config file parameters:
    1. the geneset (based on the ENSG, mind the GRCh37/GRCh38 differences in ENSG)
    2. the impact / impact-categories
    3. if missense are kept, filtering them on their impact (using scores such as the mpc or the cadd)
    4. the gnomad frequency
    5. the pext
  • the variant/transcript are then sorted according to criteria given by the user in the config file from the most important to the least important
  • for each sample, variant and gene (ENSG) the first transcript (most important given by the config criteria) is kept unless the --keep-all-transcripts option is used.

pext file

The pext is a bed file with the following columns (order important, there must be some header):

chr	start	end	max_brain	ensg	symbol

Need to have the genome version to match the data (GRCh37/38 and using the chr or not in the chromosome names)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ghfc_utils-0.0.5.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ghfc_utils-0.0.5-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file ghfc_utils-0.0.5.tar.gz.

File metadata

  • Download URL: ghfc_utils-0.0.5.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for ghfc_utils-0.0.5.tar.gz
Algorithm Hash digest
SHA256 6ab12f6a41b985d03addfd432a278551eeff8ff62068364054c346478a0e6eb7
MD5 679a11b00ad5317b2781c43dfb1b3c44
BLAKE2b-256 180a729ed3a446b476e8fbe435c3a8248fc808719f962cf4cd8c76a2131eab0b

See more details on using hashes here.

File details

Details for the file ghfc_utils-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: ghfc_utils-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for ghfc_utils-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4074d8ba05546bc4a0fc6e6114fb0045adf8775c522fcbe0c1ff0d02df2602d4
MD5 ebe94c862e8de5aae04175eaef7e449b
BLAKE2b-256 9c66026ea0861a38277a5fa024ce080f9e1b50b549f67a4eb9fb4ab49ae20839

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page