Skip to content

Commit 7353f39

Browse files
EkinEkin
authored andcommitted
docs: polished readme
1 parent 20f8df8 commit 7353f39

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -115,17 +115,7 @@ Schematic of RIG-I → IFN → ISG antiviral cascade. Viral RNA detection by DDX
115115

116116
## Biological Interpretation
117117

118-
The transcriptional signature reflects innate antiviral immunity:
119-
120-
1. **Detection**: DDX58 (RIG-I) senses cytoplasmic viral RNA
121-
2. **Signal transduction**: MAVS → TBK1 → IRF3/7 activation
122-
3. **Interferon response**: Type I IFN production and signalling
123-
4. **Effector functions**:
124-
- IFIT1/2/3: Block viral protein synthesis
125-
- OAS3: Activates RNase L for RNA degradation
126-
- CXCL10: Recruits effector lymphocytes
127-
128-
This response is protective during acute infection but may contribute to immunopathology in severe COVID-19.
118+
The transcriptional signature is consistent with innate antiviral immunity. DDX58 (RIG-I) detects viral RNA, signalling proceeds via MAVS/TBK1/IRF3/7, and type I interferon responses induce canonical ISGs (including IFIT1/2/3, OAS3, and CXCL10). This pattern is expected in acute infection and supports the observed enrichment of antiviral pathways.
129119

130120
## Quick Start
131121
```sh
@@ -140,21 +130,31 @@ Analysis runtime: ~0.5 min after data download (~2GB).
140130

141131
### Notes
142132
- To re-download the GEO dataset (otherwise the pipeline reuses existing `data/*.rds` outputs): `FORCE_DOWNLOAD=true Rscript scripts/00_get_data.R`
143-
- Quality checks:
144-
- Lint: `Rscript dev/lint.R`
145-
- Tests: `Rscript -e 'testthat::test_dir("tests/testthat")'`
133+
- Lint: `Rscript dev/lint.R`
134+
- Tests: `Rscript -e 'testthat::test_dir("tests/testthat")'`
146135
- Reproducibility details (expected outputs, network requirements): see `REPRODUCIBILITY.md`
147136

148-
## Citation
137+
## Citation Metadata
149138
- Zenodo DOI: `10.5281/zenodo.18432519`
150139
- For citation tooling, see `CITATION.cff`
151140

152141
## Project Structure
153142
```
154143
bulk-rnaseq-differential-expression/
144+
├── .github/
145+
│ └── workflows/
146+
│ └── ci.yml # CI (renv status, lint, tests)
147+
├── .lintr # lintr configuration
148+
├── .Rprofile # renv autoloader
155149
├── 000_install_dependencies.R # Install all required packages
150+
├── CITATION.cff
151+
├── REPRODUCIBILITY.md
156152
├── dev/
157153
│ └── lint.R # Lint scripts/ via lintr
154+
├── renv/
155+
│ ├── activate.R
156+
│ └── settings.json
157+
├── renv.lock
158158
├── run_all.R # Run complete pipeline
159159
├── scripts/
160160
│ ├── 00_get_data.R
@@ -254,7 +254,7 @@ Session info recorded in `results/session_info.txt`. All random processes use fi
254254

255255
MIT
256256

257-
## Citation
257+
## How to Cite
258258

259259
This repository:
260260
> Kahraman, E. (2026). SARS-CoV-2 Host Response in Nasopharyngeal RNA-seq. Zenodo. https://doi.org/10.5281/zenodo.18432519

0 commit comments

Comments
 (0)