Skip to content

Commit 482832c

Browse files
committed
cookbook: add introduction
1 parent 6c6e9f7 commit 482832c

2 files changed

Lines changed: 53 additions & 0 deletions

File tree

cookbook/_quarto.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ book:
99
site-url: https://uconn-scs.github.io/msDiaLogue/cookbook/
1010
chapters:
1111
- index.qmd
12+
- intro.qmd
1213

1314
bibliography: ../inst/REFERENCES.bib
1415

cookbook/intro.qmd

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Introduction {.unnumbered}
2+
3+
4+
## What is msDiaLogue?
5+
6+
7+
**msDiaLogue** is an R package developed through a collaboration between
8+
the [Proteomics & Metabolomics Facility (PMF)](https://proteomics.uconn.edu/)
9+
and the [Statistical Consulting Services (SCS)](https://statsconsulting.uconn.edu/)
10+
at the [University of Connecticut (UConn)](https://uconn.edu/)
11+
It provides a modular workflow for analyzing untargeted mass spectrometry
12+
(MS)-based proteomics data, together with a wide range of visualization options
13+
for both Data-Dependent Acquisition (DDA) and Data-Independent Acquisition (DIA)
14+
datasets.
15+
16+
17+
::: {style="text-align: center;"}
18+
[![UConn](https://raw.githubusercontent.com/uconn-scs/msDiaLogue/main/man/figures/uconn.png){style="width:34%; margin:0 2%"}](https://uconn.edu/)
19+
[![CORE](https://raw.githubusercontent.com/uconn-scs/msDiaLogue/refs/heads/main/man/figures/core.png){style="width:30.6%; margin:0 2%"}](https://core.uconn.edu/)
20+
[![SCS](https://raw.githubusercontent.com/uconn-scs/msDiaLogue/refs/heads/main/man/figures/scs.png){style="width:25.5%; margin:0 0%"}](https://statsconsulting.uconn.edu/)
21+
:::
22+
23+
24+
## Design philosophy
25+
26+
27+
Unlike monolithic analysis pipelines, **msDiaLogue** is designed as a modular
28+
workflow.
29+
Each analysis step is implemented as an independent module that can be used on
30+
its own or combined with other modules.
31+
This design allows users to adapt the workflow to different experimental designs,
32+
software platforms, and analysis objectives.
33+
34+
35+
## Workflow
36+
37+
38+
:::: {style="text-align: center;"}
39+
![](https://raw.githubusercontent.com/uconn-scs/msDiaLogue/refs/heads/main/man/figures/workflow.png)
40+
::::
41+
42+
43+
## Organization of this cookbook
44+
45+
46+
The cookbook is organized into independent recipes corresponding to the major
47+
modules of **msDiaLogue**.
48+
Each chapter introduces one module using practical examples and can be read
49+
independently.
50+
Readers may follow the recipes in sequence as a complete workflow or use
51+
individual chapters as references for specific analysis tasks.
52+

0 commit comments

Comments
 (0)