Skip to content

Commit

Permalink
Add known issues section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Christoph Hafemeister committed Oct 20, 2020
1 parent d59d4e8 commit 4593a86
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ Available vignettes:
[Variance stabilizing transformation](https://rawgit.com/ChristophH/sctransform/master/supplement/variance_stabilizing_transformation.html)
[Using sctransform in Seurat](https://rawgit.com/ChristophH/sctransform/master/supplement/seurat.html)

## Known Issues

* `error in evaluating the argument 'x' in selecting a method for function 't': missing value where TRUE/FALSE needed` - this is happens when poisson regression fails due to poor initialization (affected methods are poisson, qpoisson, nb_fast). The problem has been fixed in the develop branch. (issue #71)
* There can be problems deploying shiny apps due to the `biocViews:` line in the DESCRIPTION file. Fixed in the develop branch. (issue #72)
* No residuals when using `method = 'glmGamPoi'` while specifying a `batch_var`. Fixed in the develop branch. (issue #74)

To install from the develop branch run `remotes::install_github("ChristophH/sctransform@develop")`

## News
For a detailed change log have a look at the file [NEWS.md](https://github.com/ChristophH/sctransform/blob/master/NEWS.md)

Expand Down

0 comments on commit 4593a86

Please sign in to comment.