rnakinet

Name	rnakinet JSON
Version	1.0.0 JSON
	download
home_page	https://github.com/maragkakislab/RNAkinet
Summary	Package for predicting 5EU in nanopore reads and predicting RNA halflives
upload_time	2024-08-30 14:35:19
maintainer	None
docs_url	None
author	None
requires_python	<3.11,>=3.8
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # RNAkinet
RNAkinet is a project dedicated to detecting 5eu-modified reads directly from the raw nanopore sequencing signal. Furthermore, it offers tools to calculate transcript halflives.

# Usage
## Installation
```sh
pip install rnakinet
```
## Predict 5EU in your fast5 files
```sh
rnakinet-inference --path <path_to_folder_containing_fast5s> --output <predictions_name.csv>
```
This creates a csv file with columns `read_id` - the read id, `5eu_mod_score` - the raw prediction score from 0 to 1, `5eu_modified_prediction` - Boolean column, True if the read is predicted to be modified by 5EU, False otherwise

Nvidia GPU is recommended to run this command. If you want to run inference on a CPU-only machine, use the `--use-cpu` option. This will substantially increase runtime.

### Example
```sh
rnakinet-inference --path data/experiment/fast5_folder --output preds.csv
```
### R9 and R10 kits
RNAkinet can be run on fast5 files produced by nanopore R9 and R10 kits. You can specify your kit using the `--kit` option. Note that the R10 version is a work in progress.
```sh
rnakinet-inference --path data/experiment/fast5_folder --kit r10 --output preds.csv
```

## Calculate transcript halflives
```sh
rnakinet-predict-halflives --transcriptome-bam <path_to_transcriptome_alignment.bam> --predictions <predictions_name.csv> --tl <experiment_tl> --output <halflives_name.csv>
```

The `--tl` parameter is the duration for which the cells were exposed to 5EU in hours

The `--predictions` parameter is the output file of the 5EU prediction step described above

This creates a csv file with columns `transcript` - the transcript identifier from your BAM file, `reads` - the amount of reads available for the given transcript, `percentage_modified` - the percentage of reads of the given transcript that were predicted to contain 5EU, `pred_t5` - the predicted halflife of the given transcript

### Example
```sh
rnakinet-predict-halflives --transcriptome-bam alignments/experiment/transcriptome_alignment.bam --predictions preds.csv --tl 2.0 --output halflives.csv
```

Note that the calculated halflives `pred_t5` are the most reliable for transcripts with high read count. 
The following plots show correlation of halflives computed from RNAkinet predictions with experimentaly measured halflives [1] as we increase read count requirement.
We recommend users to acknowledge this and put more confidence in halflife predictions for transcripts with high read count, and less confidence for transcripts with low read count.

<img src="https://github.com/user-attachments/assets/b01b062a-1b64-4de4-b076-fb0c4ebb84e8" width="400" height="400">
<img src="https://github.com/user-attachments/assets/09508b62-7500-49e1-b3b8-00ca119c0f02" width="400" height="400">

[1] Eisen,T.J., Eichhorn,S.W., Subtelny,A.O., Lin,K.S., McGeary,S.E., Gupta,S. and Bartel,D.P.
(2020) The Dynamics of Cytoplasmic mRNA Metabolism. Mol. Cell, 77, 786-799.e10.




            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/maragkakislab/RNAkinet",
    "name": "rnakinet",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.11,>=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/7b/71/e1f49510fab5ec09380f8adc15139bedc17c7710624f6e90202992533120/rnakinet-1.0.0.tar.gz",
    "platform": null,
    "description": "# RNAkinet\nRNAkinet is a project dedicated to detecting 5eu-modified reads directly from the raw nanopore sequencing signal. Furthermore, it offers tools to calculate transcript halflives.\n\n# Usage\n## Installation\n```sh\npip install rnakinet\n```\n## Predict 5EU in your fast5 files\n```sh\nrnakinet-inference --path <path_to_folder_containing_fast5s> --output <predictions_name.csv>\n```\nThis creates a csv file with columns `read_id` - the read id, `5eu_mod_score` - the raw prediction score from 0 to 1, `5eu_modified_prediction` - Boolean column, True if the read is predicted to be modified by 5EU, False otherwise\n\nNvidia GPU is recommended to run this command. If you want to run inference on a CPU-only machine, use the `--use-cpu` option. This will substantially increase runtime.\n\n### Example\n```sh\nrnakinet-inference --path data/experiment/fast5_folder --output preds.csv\n```\n### R9 and R10 kits\nRNAkinet can be run on fast5 files produced by nanopore R9 and R10 kits. You can specify your kit using the `--kit` option. Note that the R10 version is a work in progress.\n```sh\nrnakinet-inference --path data/experiment/fast5_folder --kit r10 --output preds.csv\n```\n\n## Calculate transcript halflives\n```sh\nrnakinet-predict-halflives --transcriptome-bam <path_to_transcriptome_alignment.bam> --predictions <predictions_name.csv> --tl <experiment_tl> --output <halflives_name.csv>\n```\n\nThe `--tl` parameter is the duration for which the cells were exposed to 5EU in hours\n\nThe `--predictions` parameter is the output file of the 5EU prediction step described above\n\nThis creates a csv file with columns `transcript` - the transcript identifier from your BAM file, `reads` - the amount of reads available for the given transcript, `percentage_modified` - the percentage of reads of the given transcript that were predicted to contain 5EU, `pred_t5` - the predicted halflife of the given transcript\n\n### Example\n```sh\nrnakinet-predict-halflives --transcriptome-bam alignments/experiment/transcriptome_alignment.bam --predictions preds.csv --tl 2.0 --output halflives.csv\n```\n\nNote that the calculated halflives `pred_t5` are the most reliable for transcripts with high read count. \nThe following plots show correlation of halflives computed from RNAkinet predictions with experimentaly measured halflives [1] as we increase read count requirement.\nWe recommend users to acknowledge this and put more confidence in halflife predictions for transcripts with high read count, and less confidence for transcripts with low read count.\n\n<img src=\"https://github.com/user-attachments/assets/b01b062a-1b64-4de4-b076-fb0c4ebb84e8\" width=\"400\" height=\"400\">\n<img src=\"https://github.com/user-attachments/assets/09508b62-7500-49e1-b3b8-00ca119c0f02\" width=\"400\" height=\"400\">\n\n[1] Eisen,T.J., Eichhorn,S.W., Subtelny,A.O., Lin,K.S., McGeary,S.E., Gupta,S. and Bartel,D.P.\n(2020) The Dynamics of Cytoplasmic mRNA Metabolism. Mol. Cell, 77, 786-799.e10.\n\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Package for predicting 5EU in nanopore reads and predicting RNA halflives",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://github.com/maragkakislab/RNAkinet"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "494be465a8464a8dc38a3857d56f3c65e73618154b7801818156d2484914beb8",
                "md5": "61391f6088ae1c12cd494a591bcc18f9",
                "sha256": "597a94da50f1e19b9f427ecce22e7b594bdd4a8e3bbbfd6df2541a46e1823aef"
            },
            "downloads": -1,
            "filename": "rnakinet-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "61391f6088ae1c12cd494a591bcc18f9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.11,>=3.8",
            "size": 1300745,
            "upload_time": "2024-08-30T14:35:17",
            "upload_time_iso_8601": "2024-08-30T14:35:17.465372Z",
            "url": "https://files.pythonhosted.org/packages/49/4b/e465a8464a8dc38a3857d56f3c65e73618154b7801818156d2484914beb8/rnakinet-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7b71e1f49510fab5ec09380f8adc15139bedc17c7710624f6e90202992533120",
                "md5": "b95273c6834a4e34635bc463bcb31aa9",
                "sha256": "ef34b62b9b0baecd030791e3bd8f9e2d3da29aedbf34b5c454e9b68d8d44686e"
            },
            "downloads": -1,
            "filename": "rnakinet-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b95273c6834a4e34635bc463bcb31aa9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.11,>=3.8",
            "size": 1296199,
            "upload_time": "2024-08-30T14:35:19",
            "upload_time_iso_8601": "2024-08-30T14:35:19.759135Z",
            "url": "https://files.pythonhosted.org/packages/7b/71/e1f49510fab5ec09380f8adc15139bedc17c7710624f6e90202992533120/rnakinet-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-30 14:35:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "maragkakislab",
    "github_project": "RNAkinet",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "rnakinet"
}