Skip to content

Commit

Permalink
update readmes and remove examples
Browse files Browse the repository at this point in the history
  • Loading branch information
iblacksand committed Apr 25, 2024
1 parent f71222f commit fa50628
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 8 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ ref.txt
target_symbols.txt
/*.gmt
/*.rnk
test.json
test.txt
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This CLI is focused purely on computation. **It does not provide GMT files or HT

## Install

Requires the [rust toolchain](https://rustup.rs/). Then run the following command in your terminal:

```shell
cargo install webgestalt
```
Expand All @@ -25,5 +27,5 @@ webgestalt --help
Example of running over-representation analysis using `kegg.gmt`, with an interesting list at `int.txt` and a reference of `ref.txt`. Outputs JSON file at `output.json`

```shell
ora -g kegg.gmt -i int.txt -r ref.txt -o output.json
webgestalt ora -g kegg.gmt -i int.txt -r ref.txt -o output.json
```
4 changes: 0 additions & 4 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@ use webgestalt_lib::methods::nta::NTAConfig;
use webgestalt_lib::methods::ora::ORAConfig;
use webgestalt_lib::readers::utils::Item;
use webgestalt_lib::readers::{read_gmt_file, read_rank_file};

/// WebGestalt CLI.
/// ORA and GSEA enrichment tool.
/// Created by John Elizarraras from the Bing Zhang Lab.
#[derive(Parser)]
#[command(author, version, about, long_about = None)]
struct CliArgs {
Expand Down
1 change: 0 additions & 1 deletion test.json

This file was deleted.

1 change: 0 additions & 1 deletion test.txt

This file was deleted.

3 changes: 2 additions & 1 deletion webgestalt_lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ 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`.

```toml
webgestalt_lib = "0.2.0" # change to wanted version
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.
Expand Down

0 comments on commit fa50628

Please sign in to comment.