Add more information to the README

AlexsLemonade · Jan 25, 2020 · 4ec4aec · 4ec4aec · mkoptyra · Jan 30, 2020
1 parent 5058543
commit 4ec4aec
Showing 1 changed file with 15 additions and 2 deletions.
diff --git a/analyses/molecular-subtyping-chordoma/README.md b/analyses/molecular-subtyping-chordoma/README.md
@@ -1,2 +1,15 @@
-## Molecular  subtypiong of chodomas
-Mateusz Koptyra 20191121
+## Molecular subtyping of chordomas
+
+**Module authors:** Mateusz Koptyra ([@mkoptyra](https://github.com/mkoptyra))
+
+This module consists of a single notebook that looks at _SMARCB1_ focal copy status and expression levels.
+It can be run via the command line with the following:
+
+```
+Rscript -e "rmarkdown::render('01-Subtype-chordoma.Rmd', clean = TRUE)"
+```
+
+### Notes on copy status
+
+This notebook uses an older version of annotated CNVkit file from the `focal-cn-file-preparation` ([`fa21429`](https://github.com/AlexsLemonade/OpenPBTA-analysis/tree/fa214291713575be7fd20c92374b268870f4173f)) as the current version of the annotated file from CNVkit may be too restrictive (see: [#473](https://github.com/AlexsLemonade/OpenPBTA-analysis/issues/473)). 
+This will need to be updated to use the copy number consensus file as well.