check_segment: Check segment name

In kueckelj/SPATA: A Toolbox for Spatial Gene Expression Analysis

Check segment name

Description

A member of the adjusting-check_*()-family. Takes the segment name as a single character value, check whether such a segment exists in the specified spata-object. If no an error is raised. Else the barcodes of spots belonging to the specified segment are returned.

Usage

check_segment(object, segment_name, of_sample = "")

Arguments

object	A valid spata-object.
segment_name	The segment of interest specified as a single character value.

Details

Members of the adjusting-check_*()-family take their arguments input and compare it to a variety of requirement settings by running several logical tests. If the input turns out to be appropriate for the main-function they return it the way it is supposed to be returned. If not, depending on the degree of deviation from the optimum, they either adjust the input in order not to interrupt the function or - if not adjustable - raise an error. In both cases informative messages will be printed in order to let the user know what has been adjusted or what part of the input was insufficient.

Value

The original input, an adjusted version of it or an error. In the latter two cases they print an informative message about what was going on.

kueckelj/SPATA documentation built on March 22, 2022, 9:59 p.m.