Skip to content

Commit

Permalink
rtd updates
Browse files Browse the repository at this point in the history
  • Loading branch information
maximilianh committed Dec 7, 2018
1 parent f8ad01c commit 33378ab
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 40 deletions.
39 changes: 2 additions & 37 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@ under ~/public_html/cells to an empty directory on a webserver and point your
web browser to it. E.g. many universities give their members webspace,
sometimes in a directory called ~/public_html or on a special server. If you
don't have that, contact us or use Cyverse or Amazon S3 to host your files, not
Dropbox. You cannot use Dropbox, iCloud OneDrive or Google Drive, they are not webservers.
Dropbox. You cannot use online backup solutions like Dropbox, iCloud OneDrive
or Google Drive, they are not webservers.

To add more datasets, go to the other data directories and run cbBuild
there, with the same output directory. cbBuild will then modify the index.html
Expand Down Expand Up @@ -245,42 +246,6 @@ Let's use an example, the pbmc3k cellranger output files from the 10x website:
cd cellrangerOut
cbBuild -o ~/public_html/cells -p 9999

### Process an expression matrix with a basic Seurat pipeline

First make sure that you can install the package "hdf5r" in R:

Rscript -e "install.packages('hdf5r' , dep=TRUE, repos='http://cran.r-project.org/')"

If the above doesn't work, try installing the fake-hdf5r package, which means that you won't be able to read
hdf5 files, but reading .mtx and of course tab-sep files will still work:

Rscript -e "install.packages('remotes' , dep=TRUE, repos='http://cran.r-project.org/')"
Rscript -e "remotes::install_github('UCSF-TI/fake-hdf5r')"

Then install Seurat into your default command line R (not RStudio or another R version you may have):

Rscript -e "install.packages(c('Seurat', 'data.table'), dep=TRUE, repos='http://cran.r-project.org/')"

To run an example now, download the 10X pbmc3k expression matrix:

rsync -Lavzp genome-test.gi.ucsc.edu::cells/datasets/pbmc3k/ ./pbmc3k/ --progress

Create a default seurat.conf:

cbSeurat --init

You can modify seurat.conf but the default values are good for this dataset.
Now run the expression matrix filtered_gene_bc_matrices/hg19/matrix.mtx through Seurat like this:

cbSeurat -e filtered_gene_bc_matrices/hg19 --name pbmc3kSeurat -o seuratOut

This will create a script seuratOut/runSeurat.R, run it through Rscript and will fill the directory seuratOut/ with everything needed to create a cell browser. Now you can build your cell browser from the Seurat output:

cd seuratOut
cbBuild -o

You can modify the file seurat.conf and rerun the cbSeurat command above.

### Adding a dataset from tab-separated files

Go to the directory with the expression matrix and the cell annotations. Start from a sample cellbrowser.conf:
Expand Down
1 change: 0 additions & 1 deletion docs/cellbrowser.conf

This file was deleted.

1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@


# -- Project information -----------------------------------------------------
sys.path.insert(0, "cbPyLib")
import cellbrowser

project = 'cellbrowser'
Expand Down
6 changes: 4 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
import setuptools
import versioneer

with open("pypi/README.md", "r") as fh:
long_description = fh.read()

setuptools.setup(
name="cellbrowser",
version="0.4.24",
version=versioneer.get_version(),
cmdclass=versioneer.get_cmdclass(),
license="GPL 3",
python_requires='>=2.5',
author="Maximilian Haeussler",
author_email="max@soe.ucsc.edu",
url="https://github.com/maximilianh/cellBrowser",
description="UCSC Cellbrowser for single cell data. Includes tab-sep command line importer, dataset converter tools for Seurat, Scanpy and Cellranger and two basic pipelines to process an expression matrix.",
description="UCSC Cellbrowser, an interactive browser for single cell data. Includes converters and basic pipelines for text files, Seurat, Scanpy and Cellranger.",
long_description=long_description,
long_description_content_type="text/markdown",
packages=setuptools.find_packages("src/cbPyLib/"),
Expand Down

0 comments on commit 33378ab

Please sign in to comment.