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.

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

Documentation update #402

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 0 additions & 11 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -175,17 +175,6 @@

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2022 PGS Catalog Team (Samuel Lambert, Ben Wingfield, Michael
Inouye, Aoife McMahon, Laurent Gil)

Expand Down
6,465 changes: 6,465 additions & 0 deletions docs/_static/example_report.html

Large diffs are not rendered by default.

6,419 changes: 6,419 additions & 0 deletions docs/_static/test_report.html

Large diffs are not rendered by default.

11 changes: 7 additions & 4 deletions docs/explanation/output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The pipeline outputs are written to a results directory (``--outdir`` default is
``./results/``) with the following structure:

.. code-block:: console

results
├── [sampleset] (directory with results for your data)
│ ├── match (scoring files and variant match metadata)
Expand Down Expand Up @@ -89,6 +89,8 @@ reference panel and scoring files, a summary of the computed genetic ancestry da
the distribution of scores in your dataset(s) as a density plot. Some of the sections are only displayed with
``--run_ancestry``, but we show them all here for reference.

Example reports of the :download:`the test profile <../_static/test_report.html>` and :download:`ancestry analysis <../_static/example_report.html>` are available to view.

The first section of the report reproduces the nextflow command, and scoring file metadata (imported from the PGS Catalog
for each PGS ID) describing the scoring files that were applied to your sampleset(s):

Expand Down Expand Up @@ -130,16 +132,17 @@ similar to those populations is also provided.
populations correctly), and that the projection of individuals from the target dataset looks sensible.


The final section shows an example of the main results dataframe that contains the sample identifiers and
calculated PGS in the *Score extract* section. A visual display of the PGS distribution for a set of example
The final section describes the number of scores that were calculated successfully. A visual display of the PGS distribution for a set of example
score(s) (up to 6) is provided in the *Density plot* panel which can be helpful for looking at the distributions of the
scores in the target and reference dataset and how it changes for difference PGS adjustment methods:

.. figure:: screenshots/Report_4_Scores.png
:width: 600
:alt: Example PGS Catalog Report: table and density plots of score distributions

**Figure 4. Example of the** ``[sampleset]_pgs.txt.gz`` **table and plots of PGS distributions.**
**Figure 4. Example scores section including plots of PGS distributions.**

Plots are only created in the report if 50 or more samples are present in the target genomes.

``match/``
----------
Expand Down
Binary file modified docs/explanation/screenshots/Report_4_Scores.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading