Skip to content

Commit

Permalink
Adding section about atac-seq datasets
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewspeir committed May 4, 2021
1 parent e22f98b commit 76d98bc
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions docs/howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -292,3 +292,63 @@ You will specifically need to edit these lines to point to the flies that you ex
]
You will still need to set the other `required settings <https://github.com/maximilianh/cellBrowser/blob/master/src/cbPyLib/cellbrowser/sampleConfig/cellbrowser.conf#L1>`_ in your cellbrowser.conf as well



How to visualize single-cell ATAC-seq data in the Cell Browser
^^^^

The Cell Browser supports single-cell ATAC-seq data, it requires the same files that a standard dataset needs with the added requirement of knowing the gene models to use.

Step 1: Gather required files
""""

You will the following three files:
* Expression matrix with cell names as columns and peak ranges as rows.
* Cell annotations/metadata
* Layout coordinats (e.g. UMAP)

Step 2: Determine GENCODE Gene Model version
""""

To enable searching for peaks around genes, the Cell Browser requires a set of gene models be specified. Typically ATAC-seq includes a gene signal analysis as well, so that should be the set of gene models you declare here.

If you don't know the GENCODE version used, cbGenes can determine the most likely version used:

::

cbGenes guess exprMatrix.tsv.gz human

The first column of this file should be gene symbols of GENCODE gene IDs.

Step 3: Download the gene model files
""""

Once you know the version, download the appropriate files to your cellbrowserData directory:

::

cbGenes fetch gencode-34 # geneId -> symbol mapping for human gencode relase 34
cbGenes fetch hg38.gencode-34 # gene -> chrom mapping for human gencode relase 34

Both files are required for this to work.

Step 4: Set up your cellbrowser.conf
""""

You will need to add the following lines to your ``cellbrowser.conf``:

::

atacSearch = "hg38.gencode-34" # Put here the name of the version downloaded in Step 3 combined with the ucsc assembly name
geneLabel = "Peak"

You will still need to set the other `required settings <https://github.com/maximilianh/cellBrowser/blob/master/src/cbPyLib/cellbrowser/sampleConfig/cellbrowser.conf#L1>`_ in your cellbrowser.conf as well

Step 5: Build your Cell Browser
""""

After all is set up, build your cell browser:

::
cbBuild -o alpha

0 comments on commit 76d98bc

Please sign in to comment.