shape_check: Check Matrix X is (N x 1)

View source: R/shape_check.R

shape_checkR Documentation

Check Matrix X is (N x 1)

Description

shape_check checks whether X is a matrix representing a column vector (i.e., a matrix with 1 column). If not, shape_check attempts to coerce the user provided X to a matrix with 1 column. If this cannot be done, an error is raised.

Usage

shape_check(X)

Arguments

X

Object to check and (if possible) coerce to a single column matrix

Details

This is a utility function written to check the input X for the functions atrous_dwt and mo_dwt.

Value

An (N x 1) matrix


fastWavelets documentation built on Nov. 18, 2022, 5:12 p.m.