Skip to content

Commit

Permalink
Improve README.
Browse files Browse the repository at this point in the history
  • Loading branch information
ekernf01 committed Apr 17, 2019
1 parent b4bab40 commit add6301
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ This folder contains scripts used for analysis of the data in our recent *Immuni

## Reproduction

You will need a couple of key R packages: `Seurat` version 1.4 (from the Satija lab) and `thymusatlastools` version 1 (from the Maehr lab). We use [`freezr`](https://github.com/ekernf01/freezr) to save code and session info and to track processed data for use in downstream scripts.
You will need a couple of key R packages: `Seurat` version 1.4 (from the Satija lab) and `thymusatlastools` version 1 [from the Maehr lab](https://github.com/maehrlab/thymusatlastools). We use [`freezr`](https://github.com/ekernf01/freezr) to save code and session info and to track processed data for use in downstream scripts.

You can download the digital gene expression matrices (for both the full transcriptome and TCR realignment) from GEO accession GSE107910. Put them in the `data/` directory of this folder.

`main.Rmd` is the master script for the paper draft. To reproduce the paper, edit the variable `proj_dir` to point to this repo, then the notebook line by line. All other `.Rmd` files are called by the master script to produce figures or tables.
`main.Rmd` is the master script for the paper draft. To reproduce the paper, edit the variable `proj_dir` to point to this repo, then run the notebook line by line. All other `.Rmd` files are called by the master script to produce figures or tables.

We're passionate about reproducibility, but we know that exact reproduction is difficult. If you have any trouble, please contact `eric epu kernfeld bu vnbttnfe epu fev`, where the address has been one-letter shifted to hide from robots.
13 changes: 13 additions & 0 deletions immunity_paper_release.Rproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Version: 1.0

RestoreWorkspace: Default
SaveWorkspace: Default
AlwaysSaveHistory: Default

EnableCodeIndexing: Yes
UseSpacesForTab: Yes
NumSpacesForTab: 2
Encoding: UTF-8

RnwWeave: Sweave
LaTeX: pdfLaTeX

0 comments on commit add6301

Please sign in to comment.