Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Melissa Gymrek authored and Melissa Gymrek committed Sep 25, 2024
1 parent 4752789 commit 176fa7e
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# CITRUS🍊: A phenotype simulation tool with the flexibility to model complex interactions

CITRUS, the CIs and Trans inteRaction nUmerical Simulator, is a tool for simulating phenotypes with complex genetic archetectures that go beyond simple models that assume linear, additive contributions of individual SNPs. The goal of this tool is to provide better simulations for benchmarking GWAS/PRS models.
CITRUS, the CIs and Trans inteRaction nUmerical Simulator, is a collection of tools for simulating phenotypes with complex genetic architectures that go beyond simple models that assume linear, additive contributions of individual SNPs. The goal of CITRUS is to provide better simulations for benchmarking GWAS/PRS models.

## Installation
The key component of CITRUS is the ability to specify custom models relating genotypes to phenotypes. See the [user Guide](doc/user_guide.md) for details on specifying models. Example models are provided in `example-files/`.

CITRUS provides multiple command line utilities for performing and analyzing simulations:

For plotting models, you will need to have [graphviz](https://graphviz.org/) installed.
* [citrus simulate](doc/cli.md#simulate): Perform a simulation using a given model
* [citrus plot](doc/cli.md#plot): Visualize a phenotype model
* [citrus shap](doc/cli.md#shap): Generate SHAP values for a model

## Installation

### With conda

Expand All @@ -31,6 +37,8 @@ conda run -n citrus poetry install
conda activate citrus
```

Note, for plotting models, you will need to have [graphviz](https://graphviz.org/) installed.

## Quickstart

```
Expand All @@ -40,9 +48,10 @@ citrus plot -c example-files/linear_additive.json

## Full documentation

[Command Line Interface](doc/cli.md)

[User Guide](doc/user_guide.md)

[Designing Simulations](doc/designing_simulations.md)

[Command Line Interface](doc/cli.md)

0 comments on commit 176fa7e

Please sign in to comment.