use_siber.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/use_siber.R
\name{use_siber}
\alias{use_siber}
\title{SIBERG to calculate BI}
\usage{
use_siber(
  summarized_experiment,
  index_assay = 1,
  norm_or_method = "TMM",
  model = "LN",
  parallel = TRUE,
  no_cluster = NULL,
  ...
)
}
\arguments{
\item{summarized_experiment}{SummarizedExperiment or any data frame like object.}

\item{index_assay}{Integer - index of assay of gene expression if input object is a SummarizedExperiment.}

\item{norm_or_method}{Character/Numeric - normalization method or a scaling vector that is applied to the expression data}

\item{model}{Character - model used in the calculation of the bimodal index (see SIBERG::model)}

\item{parallel}{Logical - use parallel computation}

\item{no_cluster}{Integer - number of clusters used in parallelization | Default (number of cores - 1)}

\item{...}{further arguments for SIBERG}
}
\value{
Returns either a vector of pValues or a filtered input object.
}
\description{

}
\details{
If filter is set to TRUE the function returns an object with the same class as summarized_experiment. Otherwise a vector of p-values is returned.
}