check_coords_df: Check coords data.frame

View source: R/check-family-lazy.R

check_coords_dfR Documentation

Check coords data.frame

Description

A member of the lazy-check_*()-family.

Usage

check_coords_df(coords_df)

Arguments

coords_df

A data.frame containing information about every barcode-spot. Must contain the variables:

barcodes

Character. The barcode-sequences (+ the sample belonging) of every barcode spot.

sample

Character. The sample belonging of every barcode-spot.

x

Numeric. The x-coordinates of every barcode.

y

Numeric. The y-coordinates of every barcode.

Details

Members of the lazy-check_*()-family take the arguments of their kind - that are used in the function they are called in - and checks whether these arguments input fit the requirements. They stop and return an error immediately once they stumble upon something invalid. They do not alter or adjust input and return TRUE if the whole function has been executed without anything invalid being found.

Value

A logical value TRUE if nothing invalid has been detected or an informative error message.


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