backspin: Backspin

Description Usage Arguments References

View source: R/backspin.R

Description

The BackSPIN biclustering algorithm was developed by Amit Zeisel and is described in Zeisel et al. Cell types in the mouse cortex and hippocampus revealed by single-cell RNA-seq Science 2015 (PMID: 25700174, doi: 10.1126/science.aaa1934). Please cite this paper if you use the BackSPIN algorithm in your work. Original MATLAB implementation by Amit Zeisel. This repo contains a standalone command-line version of BackSPIN, implemented in Python by Gioele La Manno.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
backspin(
  data,
  numLevels = 2,
  first_run_iters = 10,
  first_run_step = 0.05,
  runs_iters = 8,
  runs_step = 0.25,
  split_limit_g = 2,
  split_limit_c = 2,
  stop_const = 1.15,
  low_thrs = 0.2,
  verbose = T
)

Arguments

data

Rows should be genes and columns single cells/samples.

first_run_iters

Number of the iterations used in the preparatory SPIN. Default 10

first_run_step

the step parameter passed to _generate_widlist for the preparatory SPIN. Default 0.05

runs_iters

the iterations parameter passed to the _divide_to_2and_resort. influences all the SPIN iterations except the first

verbose

Print the extra details of what is happening

levels

The number of nested splits that will be tried by the algorithm

runs_step:

the step parameter passed to the _divide_to_2and_resort. influences all the SPIN iterations except the first

split_limit_g:

If the number of specific genes in a subgroup is smaller than this number splitting of that subgrup is not allowed

split_limit_c:

If the number cells in a subgroup is smaller than this number splitting of that subgrup is not allowed

stop_const:

minimum score that a breaking point has to reach to be suitable for splitting

low_thrs:

genes with average lower than this threshold are assigned to either of the splitting group reling on genes that are higly correlated with them

References

Zeisel et. al. Science. 2015 Mar 6;347(6226):1138-42. doi: 10.1126/science.aaa1934. Epub 2015 Feb 19.


scfurl/m3addon documentation built on Aug. 9, 2021, 5:30 p.m.