Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updates to tutorial
  • Loading branch information
clee700 authored Jul 17, 2023
1 parent 80fc312 commit 36286c6
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@
<!-- README.md is generated from README.Rmd. Please edit that file -->

# scDEED (single-cell dubious embeddings detector): a statistical method for detecting dubious non-linear embeddings
- This package is used to determine the reliability of non-linear dimension reduction embeddings. It provides functions to detect dubious cells and trustworthy cells in tSNE and UMAP embeddings. Furthermore, by minimizing the number of dubious cells, functions in this package find the best perplexity parameter of tSNE and the best n.neighbors/min.dist parameter of UMAP.
- This package is used to determine the reliability of non-linear dimension reduction embeddings. It provides functions to detect dubious cells and trustworthy cells in tSNE and UMAP embeddings. The position of dubious cells in the 2D-embedding space differs from their relative position in the high-dimensional space. Furthermore, by minimizing the number of dubious cells, functions in this package find the best perplexity parameter of tSNE and the best n.neighbors/min.dist parameter of UMAP.

- Choose the suitable dimension for PCA (num_pc)
## Inputs and hyperparameters
- The number of PCs to use (num_pc). The user may choose this based on any criteria, such as an elbow plot.

- Input count matrix should contain cells as columns and genes as rows

- Dimension reduction method (use_method). Currently, the package supports tSNE and UMAP, both implemented through the Seurat package.

## Installation
You can install scDEED from GitHub using devtools. It should install in 1 minute, but may take longer if you need to update dependencies.

Expand All @@ -18,8 +21,8 @@ devtools::install_github("JSB-UCLA/scDEED")

## Example

This is a basic example showing how to find the best parameter.If users use our example input data and the default parameter list(s), users can get the result in about 2mins
We use an example input data which is generated by randomly sampled 10000 cells from Hydra data as a demo:
This is a basic example showing how to find the best parameter. If users use our example input data and the default parameter list(s), users can get the result in about 2mins
We use an example input data which is generated by randomly sampling 10000 cells from Hydra dataset as a demo:

``` r
suppressPackageStartupMessages(library(scDEED))
Expand Down

0 comments on commit 36286c6

Please sign in to comment.