Skip to content

Commit

Permalink
docs: update documentation for new heatmap
Browse files Browse the repository at this point in the history
  • Loading branch information
sof202 committed Aug 8, 2024
1 parent 6a04c02 commit 18611c5
Showing 1 changed file with 7 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ input data).

The colour palette of the heatmap is such that higher enrichment values
are a darker green and lower enrichment values are closer to white/light green.
Any negative enrichment is given with a pink box.
The actual values for the enrichment heatmap are also given and all information
is printed to a csv file.

Expand All @@ -34,7 +35,7 @@ Enrichment is defined as:
SNPs

In general you should ignore negative enrichment as
this usually stems from negative heritability (which is nonsensicle). For
this usually stems from negative heritability (which is nonsensicle).For
positive values however, the following interpretations can be made:

- An enrichment value greater than 1 implies that the regions defined by the
Expand All @@ -49,12 +50,6 @@ accounted for). Base therefore explains 100% of SNP heritability and contains
100% of all SNPs, resulting in an enrichment of 1. An enrichment of 1 is not
a significant result of partitioned heritability.

After viewing the heatmap, you will likely identify certain states/marks that
are of biological significance (high enrichment for traits you are interested
in). Before making any conclusions from this observation, make sure to look
at the relevant p-value barplot to check if the result is significant. The
high level (or low level) of enrichment might have ocurred purely by chance.

### p-value thresholds

A baseline value of 0.01 was chosen for a p-value threshold. This was arbitrary
Expand All @@ -71,6 +66,11 @@ threshold is given by the grey dotted line on the bar plots and Bonferroni
threshold is given by the black dotted line. These correction methods help
mitigate the possibility of accepting a low pvalue that ocurred due to chance.

The heatmap gives you a quick overview of the p-values with stars. A single
star means that the enrichment is fdr significant, 2 stars means the enrichment
is Bonferroni significant. For more indepth information look at the bar charts
for each gwas trait.

:::info[Number of hypotheses]
The number of hypotheses should be equal to the number of entries in the
complete (all categories) heatmap. However, the user is not actaully able to
Expand Down

0 comments on commit 18611c5

Please sign in to comment.