Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating documentation of plotting #31

Merged
merged 5 commits into from
Oct 18, 2024
+351 −282
Merged

Updating documentation of plotting #31

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1da272c
minor changes to readme
Sep 25, 2024
b6f3087
removing old commented code from plot
Sep 25, 2024
4752789
adding docstrings to plot
Sep 25, 2024
176fa7e
updating readme
Sep 25, 2024
a63163a
updating readme
Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
updating readme
Melissa Gymrek authored and Melissa Gymrek committed Sep 25, 2024
commit a63163a655600cf25d4490f3383aa3d9c2db102d
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@

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.

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/`.
The key component of CITRUS is the ability to specify custom models relating genotypes to phenotypes. See the [designing simulations](doc/designing_simulations.md) for details on specifying models. Example models are provided in `example-files/`.

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