Skip to content

Commit a365eda

Browse files
authored
Merge pull request #1 from CogDisResLab/next-peptides-removed
Next peptides removed
2 parents 5f40c96 + df4aee5 commit a365eda

4 files changed

Lines changed: 97 additions & 7 deletions

File tree

README.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# 🧬 MultiomicMenu
2+
3+
**Lead Scientist:** Dr. William G Ryan V
4+
**Last Updated:** February 11, 2026
5+
**Status:** [Draft]
6+
7+
This repository provides a standardized, configuration-driven framework for integrating high-dimensional multi-modal data (e.g., RNA-seq, Proteomics, etc.). The purpose of utilizing **Quarto (`.qmd`)** in this pipeline is to transform raw data into a fully documented, publication-ready HTML or PDF reports.
8+
9+
---
10+
11+
## 🚀 Quick Start
12+
13+
You do not need to rewrite the analysis code. Follow these steps to generate your report:
14+
15+
1. **Use the Template, Download, and Navigate to Folder:**
16+
a. Navigate to [https://github.com/CogDisResLab/MultiomicMenu](https://github.com/CogDisResLab/MultiomicMenu)
17+
b. Click "Use this template" on the upper right corner of the page.
18+
c. Choose a name for your repository. Remember to make it private for sensitive data.
19+
d. Use git clone on your new repository:
20+
```bash
21+
git clone `git clone [https://github.com/](https://github.com/)[username]/[repo-name].git`
22+
cd [repo-name]
23+
```
24+
25+
2. **Environment Setup:**
26+
Open R in the project working directory and restore the required package versions:
27+
```r
28+
if (!require("renv")) install.packages("renv")
29+
renv::restore()
30+
```
31+
3. **Configure:**
32+
Edit `index.qmd` with the following *important details*:
33+
a. title
34+
b. species
35+
c. gmt (MUST be changed if not using human data)
36+
d. data -> value -> data files
37+
4. **Render:**
38+
Execute the pipeline via the terminal:
39+
```bash
40+
quarto render .
41+
```
42+
---
43+
44+
## 📂 Repository Structure
45+
46+
* `index.qmd`: **The Single Source of Truth.** Define all hyperparameters and file paths here.
47+
* `data/`: Put your DEGs, DPPs, DAPs, or DAKs here.
48+
* `learn.qmd`: Nothing is altered here: this is for informational purposes.
49+
* `data.qmd`: All data processing is done in this step, including integration and PPI generation using Kinograte.
50+
* `pathways.qmd`: All pathway data is processed here using PAVER.
51+
* `networks.qmd`: Network diagrams are generated here using igraph.
52+
53+
---
54+
55+
## ⚙️ Configuration (`config.yaml`)
56+
57+
The pipeline logic is controlled entirely by the `config.yaml` file. Common parameters include:
58+
59+
| Parameter | Description | Default/Example |
60+
| :--- | :--- | :--- |
61+
| `title` | Title used in the final report headers. | `"MultiomicMenu Report"` |
62+
| `species` | Species used in the experiment. | `[human, rat, or mouse]` |
63+
| `gmt` | GMT file to use for pathway information. | `gmt: "https://download.baderlab.org/EM_Genesets/current_release/Human/symbol/Human_GO_AllPathways_noPFOCR_with_GO_iea_February_03_2026_symbol.gmt"` |
64+
| `data` | Data files to use. | `["kinase_stk: 'data/kinase.csv'"]` |
65+
66+
---
67+
68+
## 🧪 Statistical Framework
69+
70+
The integration primarily utilizes **Prize Collecting Steiner Forest (PCSF)** analysis with a PPI graph.
71+
72+
---
73+
74+
## 🛠 Requirements
75+
76+
* **R:** ≥ 4.5.0
77+
* **Quarto CLI:** System-level installation required ([Download](https://quarto.org/docs/get-started/)).
78+
* **Memory:** 8GB+ RAM required. 16GB+ RAM recommended.
79+
80+
---
81+
82+
## 📊 Outputs
83+
84+
Upon completion, the `results/` directory will contain:
85+
1. **`index.html`**: An interactive report featuring all of the below pages.
86+
2. **`learn.html`**: A page dedicated to describing the statistics and bioinformatics of MultiomicMenu.
87+
3. **`data.html`**: A page for describing the data, including a "prize plot" which shows the cumulative distribution of "prizes".
88+
4. **`pathways.html`**: A page for pathways that are hits in the analysis.
89+
5. **`networks.html`**: A concatenation of all networks generated in the analysis, typically including a sample network and a seeded network.
90+

data.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ combine_scores_patch <- function(df_rna = NULL, df_prot = NULL, df_kin = NULL, t
311311
combined_df <- combine_scores_patch(df_rna = data$rna,
312312
df_prot = data$protein,
313313
df_kin = data$kinase,
314-
df_pep = data$peptide,
314+
# df_pep = data$peptide,
315315
tf_kin = chea3_results)
316316
317317
string_ppi <- generate_string_ppi(params$species)

index.qmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ date: last-modified
66
date-format: "[Last Updated on] MMMM DD, YYYY"
77
params:
88
subtitle: "For Dr. XYZ"
9-
species: rat # one of: [human, mouse, rat]
10-
gmt: "https://download.baderlab.org/EM_Genesets/current_release/Rat/symbol/GO/Rat_GOALL_with_GO_iea_July_01_2024_symbol.gmt"
9+
species: human # one of: [human, mouse, rat]
10+
gmt: "https://download.baderlab.org/EM_Genesets/current_release/Human/symbol/Human_GO_AllPathways_noPFOCR_with_GO_iea_February_03_2026_symbol.gmt"
1111
data:
1212
value:
1313
# rna: "data/rna.csv"
1414
# protein: "data/protein.csv"
15-
kinase_stk: "data/creedenzymatic.csv"
15+
kinase_stk: "data/kinase.csv"
1616
# kinase_ptk: "data/kinase.csv"
17-
peptide: "data/dpp_file.csv"
17+
peptide: "data/peptides.csv"
1818
---
1919

2020
This is a MultomicMenu report.

networks.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ generate_seeded_network <- function(kinograte_res, gene, degree=1) {
7979
```
8080

8181
```{r}
82-
genes_input <- names(combined) %>% sample(100)
82+
genes_input <- combined %>% head(100) %>% names()
8383
8484
plot <- generate_subnetwork(kinograte_res, genes_input)
8585
@@ -90,4 +90,4 @@ gene_input <- names(combined) %>% sample(1)
9090
plot <- generate_seeded_network(kinograte_res, gene_input, 1)
9191
9292
plot
93-
```
93+
```

0 commit comments

Comments
 (0)