checkAutomaticCountsEstimatesArguments: Helper function to check the arguments input to...

Description Usage Arguments Value

View source: R/frenchfish.R

Description

Helper function to check the arguments input to getAutomaticCountsEstimates.

Usage

1
2
3
4
5
6
checkAutomaticCountsEstimatesArguments(
  probeCounts,
  radius,
  height,
  volumeFracCorrection
)

Arguments

probeCounts

A matrix where the first column contains the areas of the nuclear blobs (this column must be named "area" and the unit of its entries must be the square of the unit used to measure radius and height) and the remaining columns (one per probe) contain the spot counts for different probes in each nuclear blob

radius

The cells' nuclear radius (must be measured in same unit as height)

height

The section height (must be measured in same unit as radius)

volumeFracCorrection

The method used to correct for volume fraction (must be 'avg', 'max', or 'min'; defaults to 'avg')

Value

Nothing if all checks are passed; otherwise throws an error or warning message


markowetzlab/frenchFISH documentation built on June 28, 2020, 8:18 p.m.