check_sample: Check sample input

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

Check sample input

Description

A member of the adjusting-check_*()-family. Takes a character vector of sample names and checks which of these exist.

Returns an adjusted sample-vector or raises an error.

Usage

check_sample(object, of_sample = "", desired_length = NULL)

Arguments

object	A valid spata-object.
of_sample	The sample(s) of interest specified as a single character value or vector. If set to "" (the default) the first sample is chosen.
desired_length	The length the input must have.

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.