Skip to content

Commit df3b716

Browse files
committed
add info on cell type annotations to README.md. Closes #4
1 parent a28c277 commit df3b716

File tree

1 file changed

+46
-3
lines changed

1 file changed

+46
-3
lines changed

README.md

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,48 @@
11
# Ovarian cancer subtype heterogeneity
22

3+
## How can I obtain cell metadata inclluding cell type and subtype annotation (Figure 4)?
4+
5+
**Option 1: CSV files**
6+
7+
Available as CSV files in the `inst/extdata` directory of this repository:
8+
9+
* [T59](https://github.com/waldronlab/subtypeHeterogeneity/blob/master/inst/extdata/T59_cell_metadata.csv)
10+
[T76](https://github.com/waldronlab/subtypeHeterogeneity/blob/master/inst/extdata/T76_cell_metadata.csv)
11+
[T77](https://github.com/waldronlab/subtypeHeterogeneity/blob/master/inst/extdata/T77_cell_metadata.csv)
12+
[T89](https://github.com/waldronlab/subtypeHeterogeneity/blob/master/inst/extdata/T89_cell_metadata.csv)
13+
[T90](https://github.com/waldronlab/subtypeHeterogeneity/blob/master/inst/extdata/T90_cell_metadata.csv)
14+
15+
**Option 2: R SummarizedExperiment objects**
16+
17+
Assuming familiarity with R and with the [SingleCellExperiment](https://bioconductor.org/books/release/OSCA.intro/the-singlecellexperiment-class.html) container, all you would need to do is to carry out lines 290-310 here:
18+
19+
https://github.com/waldronlab/subtypeHeterogeneity/blob/0f275d2f5a582046a1f36f4150970157da6e6fe1/vignettes/singlecell.Rmd#L290
20+
21+
and access the colData of the obtained SingleCellExperiments which includes, among other things, the cell type annotation.
22+
23+
For example here for Tumor T59:
24+
25+
```R
26+
> colData(sces[["T59"]])[,c("Barcode", "subtype", "celltype")]
27+
DataFrame with 13040 rows and 3 columns
28+
Barcode subtype celltype
29+
<character> <character> <character>
30+
1 AAACCTGAGCTGCCCA-1 DIF MYE
31+
2 AAACCTGAGTCATCCA-1 DIF MYE
32+
3 AAACCTGCAAGCCCAC-1 IMR MYE
33+
4 AAACCTGCAAGCGCTC-1 DIF EPI
34+
5 AAACCTGCACGTAAGG-1 DIF EPI
35+
... ... ... ...
36+
13036 TTTGTCATCCCTTGCA-1 DIF MYE
37+
13037 TTTGTCATCCGTACAA-1 DIF MYE
38+
13038 TTTGTCATCCTCCTAG-1 DIF EPI
39+
13039 TTTGTCATCGGTCTAA-1 DIF EPI
40+
13040 TTTGTCATCTAACTCT-1 DIF MYE
41+
```
42+
43+
44+
## Overview
45+
346
This repository contains code and analysis scripts that were used for
447
conducting analysis and producing the figures of the publication:
548

@@ -15,14 +58,14 @@ Analysis as documented in this repository was carried out using
1558
[R-4.0.2](https://cran.r-project.org/) and
1659
[Bioconductor-3.11](https://www.bioconductor.org/install/).
1760

18-
**Installation:**
61+
## Installation:
1962

20-
Option 1: Docker
63+
**Option 1: Docker**
2164

2265
[Docker image](https://hub.docker.com/repository/docker/ludwigg/subtypeheterogeneity)
2366
that comes with all dependencies already installed
2467

25-
Option 2: Local installation
68+
**Option 2: Local installation**
2669

2770
Assuming [R](https://cran.r-project.org/) and
2871
[Bioconductor](https://www.bioconductor.org/install/)

0 commit comments

Comments
 (0)