|
1 | 1 | # Usage Guide |
2 | 2 |
|
| 3 | +This section provides step-by-step instructions to configure, run, and manage your analysis. |
| 4 | + |
| 5 | +--- |
| 6 | + |
3 | 7 | ## Project Configuration |
4 | 8 |
|
5 | | -Farnoosh is working on that |
| 9 | +### 1. Customize Configuration Files |
| 10 | + |
| 11 | +Edit the YAML files in the `config/` directory to reflect your study parameters: |
| 12 | +- `config_rnaseq_io.yaml`: For processing raw input into analysis-ready format. |
| 13 | + |
| 14 | +Each center should create a center-specific config file using the template: |
| 15 | + |
| 16 | +```bash |
| 17 | +config/<center_or_study_name>.yaml |
| 18 | +# Example: |
| 19 | +config/ICB_Gide.yaml |
| 20 | +``` |
| 21 | + |
| 22 | +Use `config/config_local.yaml` as a reference. |
| 23 | + |
| 24 | +--- |
| 25 | + |
| 26 | +### 2. Add Input Data |
| 27 | + |
| 28 | +Place your raw input datasets (e.g., `.rds` files) in the `data/rawdata/` directory: |
| 29 | + |
| 30 | +```bash |
| 31 | +data/rawdata/ICB_Gide.rds |
| 32 | +``` |
| 33 | + |
| 34 | +Also include gene signature metadata files: |
| 35 | + |
| 36 | +- `signature.rda` |
| 37 | +- `signature_information.csv` |
| 38 | +- Precompiled `.RData` file — [Zenodo DOI: 10.5281/zenodo.18509237](https://doi.org/10.5281/zenodo.18509237) |
| 39 | + |
| 40 | +--- |
| 41 | + |
| 42 | +## Running Your Analysis |
| 43 | + |
| 44 | +### 1. Install Dependencies |
| 45 | + |
| 46 | +If using [`pixi`](https://prefix.dev/docs/pixi/overview): |
| 47 | + |
| 48 | +```bash |
| 49 | +pixi install |
| 50 | +``` |
| 51 | + |
| 52 | +This sets up your environment with R, Bioconductor, and required packages. |
| 53 | + |
| 54 | +--- |
| 55 | + |
| 56 | +### 2. Run Local Processing |
| 57 | + |
| 58 | +Prepare analysis-ready `.rda` files from raw data: |
| 59 | + |
| 60 | +```bash |
| 61 | +Rscript workflow/scripts/runProcData.R |
| 62 | +``` |
| 63 | + |
| 64 | +--- |
| 65 | + |
| 66 | +### 3. Run Signature Scoring |
| 67 | + |
| 68 | +```bash |
| 69 | +Rscript workflow/scripts/runSigScore.R |
| 70 | +``` |
| 71 | + |
| 72 | +--- |
| 73 | + |
| 74 | +### 4. Run Association-analysis |
| 75 | + |
| 76 | +```bash |
| 77 | +Rscript workflow/scripts/runSigAssoc.R |
| 78 | +``` |
| 79 | + |
| 80 | +### 5. Run Meta-analysis |
| 81 | + |
| 82 | +```bash |
| 83 | +Rscript workflow/scripts/runMeta.R |
| 84 | +``` |
| 85 | + |
| 86 | +--- |
| 87 | + |
| 88 | +### 6. Generate Visualizations |
| 89 | + |
| 90 | +```bash |
| 91 | +Rscript workflow/scripts/runVisualization.R |
| 92 | +``` |
| 93 | + |
| 94 | +This script generates forest plots, volcano plots, and heatmaps. |
| 95 | +**Note**: `runSigCluster.R` and `runCorr.r` are considered to study signatures' distributions. |
| 96 | + |
| 97 | +--- |
| 98 | + |
| 99 | +## Tips for Managing Your Data |
| 100 | + |
| 101 | +- Use meaningful filenames (e.g., `ICB_Gide__Melanoma__PD-(L)1.rda`) |
0 commit comments