Prepare Seurat for CellRanger 3.0 #933
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If the data used for the regression contains NA values, this will lead to errors downstream. For example, if one row contains an NA value, it will be removed and create a size mismatch when a data.frame is later constructed using the residuals of all rows, or if a linear model is used, it will create a problem when the QR values are reused.
Warn on NA data being used for regression
…n of genes.tsv to use as gene names
CellRanger 3.0 is going to use a different version of the hdf5 file, which will no longer include this PYTABLES attribute.
10X is releasing a new version of CellRanger that is changing the output format. This pull request makes Seurat forward compatible with the new version. In particular, the following changes are made: **HDF5 Format** - The format of this file is changing. As Seurat is making HDF5r optional, the `Read10X_h5` function will no longer be the preferred way to load data, and we have added an error message if newer (and incompatible files are loaded.) **Text File Formats** - In order to save disk space, the sparse matrix text file will now be gzipped. As R automatically identifies and correctly reads gzipped files, no changes were needed to account for this other than appending a suffix when necessary. Additionally, in order to account for experiments that have "multimodal" datasets, the `gene.tsv` will instead become the `features.tsv` file. This file will contain an additional column describing the type of feature referred to in that row of the matrix. In order to help users follow the [multimodal vignette](https://satijalab.org/seurat/multimodal_vignette.html) and analyze this type of data, rather than return one matrix, with multimodal data a list of matrices are returned, with the name of each element in the list corresponding to the type of data. As this new data is distinct from the older types of data shown in past tutorials, we print a message when this occurs so the user is aware that they have different data types.
evolvedmicrobe
force-pushed
the
cellranger3.0for3.0
branch
from
613ae95
to
75ce008
Compare
|
Hi Seurat Team, With the new 3.0 branch, I thought it would be easier to close the old PR, and make a new one with the changes already merged in to the new Out of curiosity, is there any estimate of when 3.0 will be heading out? I've showed it to a few people who were all enthusiastic about it. Cheers, |
|
Thanks Nigel! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
10X is releasing a new version of CellRanger that is changing the output format. This pull request makes Seurat forward compatible with the new version. In particular, the following changes are made:
HDF5 Format - The format of this file is changing. As Seurat is making HDF5r optional, the Read10X_h5 function will no longer be the preferred way to load data, and we have added an error message if newer (and incompatible files are loaded.)
Text File Formats - In order to save disk space, the sparse matrix and barcode text files will now be gzipped. As R automatically identifies and correctly reads gzipped files, no changes were needed to account for this other than appending a suffix when necessary. Additionally, in order to account for experiments that have "multimodal" datasets, the gene.tsv will instead become the features.tsv file. This file will contain an additional column describing the type of feature referred to in that row of the matrix.
In order to help users follow the multimodal vignette and analyze this type of data, rather than return one matrix, with multimodal data a list of matrices are returned, with the name of each element in the list corresponding to the type of data. As this new data is distinct from the older types of data shown in past tutorials, we print a message when this occurs so the user is aware that they have different data types.
Very small test data files and associated tests were added to verify the expected behavior.
Note, this was originally PR #708 but was modified to merge into the latest
release/3.0branch.