webgestalt_lib
| Crates.io | webgestalt_lib |
| lib.rs | webgestalt_lib |
| version | 0.3.1 |
| source | src |
| created_at | 2024-01-11 16:56:37.097152 |
| updated_at | 2024-06-20 17:43:45.630375 |
| description | Library for computing enrichment for different analytes using ORA or GSEA. |
| homepage | |
| repository | https://github.com/bzhanglab/webgestalt_rust |
| max_upload_size | |
| id | 1096512 |
| size | 1,483,261 |
John Elizarraras (iblacksand)
documentation
README
webgestalt_lib
Library for performing different types of enrichment analyses. Serves as the underlying core for WebGestaltPy, WebGestaltR, and the pure-Rust CLI in this repository.
Methods
Supported methods include:
- Over-Representation Analysis (ORA)
- Gene Set Enrichment Analysis (GSEA)
- Network topology-based analysis (NTA)
Installation
To use webgestalt_lib in your Rust project, add the following line to your Cargo.toml.
webgestalt_lib = "0.3.0" # change to wanted version
If you are just interested in running an analysis, rather than develop new tools, please use one of the packages mentioned at the beginning of the README.
Development Priorities
- Fast and correct implementations of enrichment methods
- Full compatibility with the WebGestaltR package
- The R package provides the most reporting functionality, and this project was initially created to only assist the R package with the computation aspects
- Fast compilation times
- Every package install has to build the library from scratch, so the lower number of dependencies, the better
This crate does not provide any data formatting or charts to display the results of the analysis. This work has already been done by the R package, and a limited implementation is provided by the Rust CLI. The focus for this library is purely computational.
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.