hs_phenoRam: Calculate the phenotypic heterogeneity indices for each cell

Description Usage Arguments Examples

View source: R/hs_phenoRam.R

Description

Calculate the phenotypic heterogeneity indices for each cell

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
hs_phenoRam(
  hs.x,
  preprocess = FALSE,
  smooth = FALSE,
  align = FALSE,
  path = NULL,
  trim.range = c(400, 1800),
  pattern = ".spc",
  niter = 10,
  return_spectra = TRUE,
  peak_detection = FALSE,
  peak_window = 20,
  peak_method = c("MAD")
)

Arguments

hs.x

HyperSpec object

preprocess

Preprocess? TRUE/FALSE. Defaults to FALSE.

smooth

Option for preprocessing. Defaults to FALSE.

align

Align option for preprocessing. Defaults to FALSE.

path

path where Raman data is located, only useful if preprocess==TRUE

trim.range

Wavenumber range to trim from raw spectra. Only used if preprocess==TRUE

pattern

(POSIX) regular expression used to select files (defaults to ".spc"), only used if preprocess==TRUE Options are "MAD" and "SuperSmoother"

niter

Number of iteration Option for preprocessing. Defaults to FALSE.

return_spectra

Should hyperSpec object be returned as final object? Defaults to TRUE.

peak_detection

Should peak detection be used instead of raw spectra for Hill calculations? Defaults to FALSE

peak_window

Peak windows size for a peak to be considered a signal. Defaults to 20.

peak_method

Which peak detection method should be used (requires peak_detection == TRUE).

Examples

1
2
3
4
5
6
7
8
# Short example
data("hs_example")

# Preprocess
hs_example <- hs_preprocess(hs_example)

# Calculate metrics
hs_phenoRam(hs.x = hs_example, preprocess = TRUE, peak_detection = TRUE)

CMET-UGent/MicroRaman documentation built on July 25, 2020, 6:20 p.m.