test_valid_ndr_object: Tests if an object is a valid NDR object

View source: R/test_valid_NDR_objects.R

test_valid_ndr_objectR Documentation

Tests if an object is a valid NDR object

Description

This function takes an object and tests whether it is a valid NDR object; i.e., whether it is an object that is either an DS, FP, CL, RM or CV object. If it is a valid NDR object, then it returns a string specifying the prefix of the type of object it is; i.e., 'ds', 'fp', 'cl', 'rm' or 'cv'. If it is not an NDR object then an error is thrown.

Usage

test_valid_ndr_object(ndr_object)

Arguments

ndr_object

An object that should be an NDR object.

Value

Returns a string if the ndr_object is a valid NDR object. The string is either 'ds', 'fp', 'cl', 'rm' or 'cv' which specifies what type of object it is. If ndr_object is not an NDR object, then an error is thrown.


emeyers/NeuroDecodeR documentation built on March 17, 2024, 6:05 p.m.