Skip to main content

Ciclops

Cross-platform training In CLinical Outcome PredictionS (ciclops) is the winning algorithm in 2019 Malaria DREAM Challenge SubChallenge 2.

Ciclops performs transfer learning from one transcriptomic platform's samples to another.

Installation

Install this package via pip:

pip install ciclops

or clone this program to your local directory:

https://github.com/GuanLab/ciclops.git

Usage

python ciclops [-h] [--train_path TRAIN_PATH] [--valid_path VALID_PATH]
               [-m MODEL_TYPE] [--no_quantile] [--shap] [-n TOP_GENES]

Pipeline for building clinical outcome prediction models on training dataset and transfer learning on validation datasets.

optional arguments:
 -h, --help            show this help message and exit
 --train_path TRAIN_PATH
                       Path to your training data, in .csv format; includes sample names as first column and labels as last column
 --valid_path VALID_PATH
                       Path to your transfer validation data, in .csv format; includes sample names as first column and labels as last column
 -m MODEL_TYPE, --model_type MODEL_TYPE
                       Machine learning models to use:
                                   lgb: LightGBM;
                                   xgb: XGBoost;
                                   rf: Random Forest;
                                   gpr: Gaussian Process Regression;
                                   lr: Linear Regression;
                                   default: lgb
 --no_quantile         If specified, do not use quantile normalization.
 --shap                Conduct SHAP analysis on the training and validation set.
                       Only for use with LightGBM, XGBoost, and Random Forest.
 -n TOP_GENES, --top_genes TOP_GENES
                       If --shap is specified, indicate number of top genes from both training and validation sets that will be compared in post-SHAP analysis.
                       Default is 20.

It will generate the following folders:

./training/: preprocessed training datasets for model training and 10-fold cross validation

./validation/: validation dataset for transferring test

./params/: trained machine learning model parameters

./performance/: model performance in 10-fold cross validation and transferring test

./SHAP/: SHAP analysis results

References

  • For the original paper, please refer to the Guan Lab's 2022 iScience paper: Machine learning for artemisinin resistance in malaria treatment across in vivo-in vitro platforms.
  • STAR Protocol (TBD)
  • External data for testing/example purposes:
    • Shaw, P.J. et al. (2015) ‘Plasmodium parasites mount an arrest response to dihydroartemisinin, as revealed by whole transcriptome shotgun sequencing (RNA-seq) and microarray study’, BMC Genomics. doi:10.1186/s12864-015-2040-0.
    • GSE59098
    • GSE151189

Metadata

Release files for ciclops 0.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ciclops 0.0.4
File Size Uploaded Provenance Actions
ciclops-0.0.4.tar.gz 12.6 kB Without provenance Details for ciclops-0.0.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ciclops 0.0.4
File Interpreter ABI Platform Actions
ciclops-0.0.4-py3-none-any.whl Python 3 none any Details for ciclops-0.0.4-py3-none-any.whl

Total release size: 25.9 kB

Release files / ciclops-0.0.4.tar.gz

Download URL ciclops-0.0.4.tar.gz
Size 12.6 kB
Tags Source
SHA-256 checksum
How to use checksums
80202caba11f94a73e35453006ba9495ed6b45ca2655a558d4de312d7aedabf2
BLAKE2b-256 checksum
How to use checksums
ed3593901955e2933f9fcce59ef27c89a667bf0a601432eaa538501dd016b453
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.8.10

Release files / ciclops-0.0.4-py3-none-any.whl

Download URL ciclops-0.0.4-py3-none-any.whl
Size 13.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
94e878a490baf0e0000d22e63a16d1f5bd969ea826ea70f72af934b693059fcb
BLAKE2b-256 checksum
How to use checksums
4a97c9bb381967ea2d275ef4f3409411f212ae20ee779879a9e8cd8aa734f795
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.8.10

Security for ciclops 0.0.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page