Skip to content

Commit

Permalink
Remove images from vignettes to reduce space
Browse files Browse the repository at this point in the history
  • Loading branch information
WillNickols committed Jul 16, 2024
1 parent cf792e9 commit 7ea6586
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 20 deletions.
21 changes: 12 additions & 9 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Package: maaslin3
Title: "Refining and extending generalized multivariate linear models for meta-omic association discovery"
Title: "Refining and extending generalized multivariate linear models
for meta-omic association discovery"
Year: 2024
Version: 3.0.0
Authors@R: c(
Expand All @@ -9,15 +10,17 @@ Authors@R: c(
Depends: R (>= 4.3)
Description: MaAsLin 3 refines and extends generalized multivariate linear models for meta-omicron association discovery. It finds abundance and prevalence associations between microbiome meta-omics features and complex metadata in population-scale epidemiological studies. The software includes multiple analysis methods (including support for multiple covariates, repeated measures, and ordered predictors), filtering, normalization, and transform options to customize analysis for your specific study.
License: MIT + file LICENSE
LazyData: false
Imports: dplyr, pbapply, lmerTest, parallel, lme4, optparse, logging, data.table, multcomp, ggplot2, RColorBrewer, patchwork, scales, rlang, hash, matrixStats, tibble, ggnewscale, kableExtra
Suggests:
knitr,
testthat (>= 2.1.0),
rmarkdown,
markdown
Imports: dplyr, pbapply, lmerTest, parallel, lme4, optparse, logging,
data.table, multcomp, ggplot2, RColorBrewer, patchwork, scales,
rlang, hash, matrixStats, tibble, ggnewscale, kableExtra
Suggests: knitr, testthat (>= 2.1.0), rmarkdown, markdown
VignetteBuilder: knitr
Collate: fit.R utility_scripts.R viz.R maaslin3.R
Collate: fit.R utility_scripts.R viz.R maaslin3.R
URL: http://huttenhower.sph.harvard.edu/maaslin3
biocViews: Metagenomics, Software, Microbiome, Normalization
BugReports: https://github.com/biobakery/maasline/issues
NeedsCompilation: no
Packaged: 2024-07-16 15:01:54 UTC; williamnickols
Author: William Nickols [aut, cre],
Jacob Nearing [aut]
Maintainer: William Nickols <[email protected]>
4 changes: 2 additions & 2 deletions vignettes/maaslin3_manual.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -295,12 +295,12 @@ scatter_plots <- maaslin_plot_results_from_output(param_list)
```

In the new summary plot below, we can see that the feature names are cleaned up, the metadata names are cleaned up, the set of metadata variables used in the coefficient plot is different, and the metadata used in the heatmap is reordered.
```{r, out.width='100%', echo=F, cache = F}
```{r, out.width='100%', echo=F, cache = F, include=F}
knitr::include_graphics("hmp2_output/figures/summary_plot.png")
```

In the association plots, the taxa and metadata have been renamed to be consistent with the results file from earlier.
```{r, echo=FALSE,out.width="49%",out.height="20%",fig.cap="The four types of association plots",fig.show='hold',fig.align='center', cache = F}
```{r, echo=FALSE,out.width="49%",out.height="20%",fig.cap="The four types of association plots",fig.show='hold',fig.align='center', cache = F, include=F}
knitr::include_graphics(c("hmp2_output/figures/association_plots/Age_Faecalibacterium prausnitzii_LM.png",
"hmp2_output/figures/association_plots/Dysbiosis_Escherichia coli_LM.png",
"hmp2_output/figures/association_plots/Age_Bifidobacterium longum_logistic.png",
Expand Down
8 changes: 4 additions & 4 deletions vignettes/maaslin3_mtx_tutorial.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ param_list <- list(input_data = df_input_data,
fit_maaslin_rna <- maaslin3(param_list)
```

```{r, out.width='100%', echo=F, cache = T}
```{r, out.width='100%', echo=F, cache = T, include=F}
knitr::include_graphics("demo_output_rna/figures/summary_plot.png")
```

Expand All @@ -214,7 +214,7 @@ param_list <- list(input_data = df_input_dataratio,
fit_maaslin_ratio <- maaslin3(param_list)
```

```{r, out.width='100%', echo=F, cache = T}
```{r, out.width='100%', echo=F, cache = T, include=F}
knitr::include_graphics("demo_output_ratio/figures/summary_plot.png")
```

Expand Down Expand Up @@ -246,7 +246,7 @@ param_list <- list(input_data = preprocess_out$rna_table,
fit_maaslin_mtx_mgx <- maaslin3(param_list)
```

```{r, out.width='100%', echo=F, cache = T}
```{r, out.width='100%', echo=F, cache = T, include=F}
knitr::include_graphics("demo_output_mtx_mgx/figures/summary_plot.png")
```

Expand Down Expand Up @@ -299,7 +299,7 @@ From this, we can see that while the models are calling different total numbers

Finally, let's plot the top CD dysbiosis results in the MTX_model, across all the models. Here we first create one object that includes all the results, then subset it to the top 10 pathways in the DNA covariate results.

```{r, fig.width=8, fig.height=4, fig.align='center', cache=T}
```{r, fig.width=8, fig.height=4, fig.align='center', cache=T, include=F}
top_pathways <- results_rna_dna$feature[order(results_rna_dna$qval_individual)][1:10]
# Specify model type
Expand Down
10 changes: 5 additions & 5 deletions vignettes/maaslin3_tutorial.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ MaAsLin 3 generates two types of output files explained below: data and visualiz
2. Visualization output files
* ``summary_plot.pdf``
* This file contain a combined coefficient plot and heatmap of the most significant associations. In the heatmap, one star indicates the individual q-value is below the parameter `max_significance`, and two stars indicate the individual q-value is below `max_significance` divided by 10.
```{r, out.width='100%', echo=F, cache = F}
```{r, out.width='100%', echo=F, cache = F, include=F}
# Rename summary plot to avoid knitting issues later
quiet_out <- file.rename('hmp2_output/figures/summary_plot.png',
'hmp2_output/figures/summary_plot_first.png')
Expand All @@ -256,7 +256,7 @@ knitr::include_graphics("hmp2_output/figures/summary_plot_first.png")
* Box plots are used for continuous data prevalence associations.
* Grids are used for categorical data prevalence associations.
* Data points plotted are after filtering, normalization, and transformation so that the scale in the plot is the scale that was used in fitting.
```{r, echo=FALSE,out.width="49%",out.height="20%",fig.cap="The four types of association plots",fig.show='hold',fig.align='center', cache = F}
```{r, echo=FALSE,out.width="49%",out.height="20%",fig.cap="The four types of association plots",fig.show='hold',fig.align='center', cache = F, include=F}
knitr::include_graphics(c("hmp2_output/figures/association_plots/age_Faecalibacterium_prausnitzii_LM.png",
"hmp2_output/figures/association_plots/dysbiosis_state_Escherichia_coli_LM.png",
"hmp2_output/figures/association_plots/age_Bifidobacterium_longum_logistic.png",
Expand Down Expand Up @@ -347,12 +347,12 @@ scatter_plots <- maaslin_plot_results_from_output(param_list)
```

In the new summary plot below, we can see that the feature names are cleaned up, the metadata names are cleaned up, the set of metadata variables used in the coefficient plot is different, and the metadata used in the heatmap is reordered.
```{r, out.width='100%', echo=F, cache = F}
```{r, out.width='100%', echo=F, cache = F, include=F}
knitr::include_graphics("hmp2_output/figures/summary_plot.png")
```

In the association plots, the taxa and metadata have been renamed to be consistent with the results file from earlier.
```{r, echo=FALSE,out.width="49%",out.height="20%",fig.cap="The four types of association plots",fig.show='hold',fig.align='center', cache = F}
```{r, echo=FALSE,out.width="49%",out.height="20%",fig.cap="The four types of association plots",fig.show='hold',fig.align='center', cache = F, include=F}
knitr::include_graphics(c("hmp2_output/figures/association_plots/Age_Faecalibacterium prausnitzii_LM.png",
"hmp2_output/figures/association_plots/Dysbiosis_Escherichia coli_LM.png",
"hmp2_output/figures/association_plots/Age_Bifidobacterium longum_logistic.png",
Expand Down Expand Up @@ -565,7 +565,7 @@ param_list <- list(input_data = taxa_table,
fit_out <- maaslin3(param_list)
```

```{r, out.width='100%', echo=F, cache = F}
```{r, out.width='100%', echo=F, cache = F, include=F}
knitr::include_graphics("ordered_outputs/figures/summary_plot.png")
```

Expand Down

0 comments on commit 7ea6586

Please sign in to comment.