Skip to content
This repository has been archived by the owner on Apr 19, 2023. It is now read-only.

Commit

Permalink
Add docs for Seurat Rds input data format
Browse files Browse the repository at this point in the history
  • Loading branch information
dweemx committed Mar 16, 2020
1 parent 0c034dd commit 511709c
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions docs/pipelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -267,8 +267,6 @@ In the generated .config file, make sur the ``cellranger_h5`` parameter is set w
[...]
Information on using 10x Genomics datasets
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Let's say the file structure of your data looks like this,

.. code::
Expand Down Expand Up @@ -315,6 +313,28 @@ In the generated .config file, make sure the ``file_paths`` parameter is set wit

- The ``suffix`` parameter is used to infer the sample name from the file paths (it is removed from the input file path to derive a sample name).

Seurat Rds
----------

Use the following profile when generating the config file:

.. code::
-profile seurat_rds
In the generated .config file, make sure the ``file_paths`` parameter is set with the paths to the ``.Rds`` files::

[...]
seurat_rds {
file_paths = "data/1k_pbmc_v*_chemistry_SUFFIX.SC__FILE_CONVERTER.Rds"
suffix = "_SUFFIX.SC__FILE_CONVERTER.Rds"
}
[...]

- The pipelines expect a Seurat v3 object contained in the .Rds file. (Seurat v2 objects are currently not supported).
- The ``suffix`` parameter is used to infer the sample name from the file paths (it is removed from the input file path to derive a sample name).

TSV
---
Use the following profile when generating the config file:
Expand Down

0 comments on commit 511709c

Please sign in to comment.