Skip to content

Commit 23e2551

Browse files
add reference to existing paper
1 parent 78799b9 commit 23e2551

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ models and the familiar visualization of volcano plots by:
2727

2828
3) Optional displaying credible intervals (CrIs) to visualize uncertainty.
2929
4) Preserving the familiar, intuitive volcano structure.
30+
31+
We are not the first to think about the concept of Bayesian volcano plots [Sousa et al. 2020](https://doi.org/10.1016/j.aca.2019.11.006) introduced them as a single
32+
use case (their b-values correspond to our pi-values)
33+
but to our knowledge we are the first to provide an R-package
34+
for easy calculation of pi-values and visualization.
3035

3136
## Installation
3237

@@ -54,7 +59,7 @@ data("annotation_df")
5459

5560
result <- prepare_volcano_df(
5661
posterior = posterior,
57-
annotation_df = annotation_df,
62+
annotation_df = annotation_df
5863
)
5964
plot_volcano(result,
6065
color="group",
@@ -64,3 +69,12 @@ plot_volcano(result,
6469
```
6570

6671
![](man/figures/README-example_volcano.png)
72+
73+
# References
74+
Julie de Sousa, Ondřej Vencálek, Karel Hron, Jan Václavík, David Friedecký, Tomáš Adam,
75+
Bayesian multiple hypotheses testing in compositional analysis of untargeted metabolomic data,
76+
Analytica Chimica Acta, Volume 1097, 2020, Pages 49-61, ISSN 0003-2670,
77+
https://doi.org/10.1016/j.aca.2019.11.006.
78+
(https://www.sciencedirect.com/science/article/pii/S0003267019313492)
79+
80+
Corresponding GitHub Repository: https://github.com/sousaju/BayesVolcano

vignettes/BayesVolcano.Rmd

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,11 @@ are volcano plots (using fold-changes and p-values).
5151
Bayesian volcano plots bring together the uncertainty aware power of Bayesian
5252
models and the familiar visualization of volcano plots.
5353

54+
We are not the first to think about the concept of Bayesian volcano plots [Sousa et al. 2020](https://doi.org/10.1016/j.aca.2019.11.006) introduced them as a single
55+
use case (their b-values correspond to our pi-values)
56+
but to our knowledge we are the first to provide an R-package
57+
for easy calculation of pi-values and visualization.
58+
5459
# Workflow
5560
## Preparation of plotting dataframe
5661

@@ -165,3 +170,11 @@ plot_volcano(results,
165170
xlab = "My informative parameter")
166171
```
167172

173+
# References
174+
Julie de Sousa, Ondřej Vencálek, Karel Hron, Jan Václavík, David Friedecký, Tomáš Adam,
175+
Bayesian multiple hypotheses testing in compositional analysis of untargeted metabolomic data,
176+
Analytica Chimica Acta, Volume 1097, 2020, Pages 49-61, ISSN 0003-2670,
177+
https://doi.org/10.1016/j.aca.2019.11.006.
178+
(https://www.sciencedirect.com/science/article/pii/S0003267019313492)
179+
180+
Corresponding GitHub Repository: https://github.com/sousaju/BayesVolcano

0 commit comments

Comments
 (0)