func_input_checks: Initial verification of input

In SLEMI: Statistical Learning Based Estimation of Mutual Information

Initial verification of input

Description

Internal, auxiliary functions

Usage

func_input_checks(data, signal, response, side_variables)

Arguments

data	is an input object that should be a data.frame
signal	is a character object that indicates input columns of data
response	is a character vector that indicates output's columns of data
side_variables	is a character vector that indicates side variables' columns of data

Value

If all initial data is valid, string "ok" is returned. Otherwise, error is given.

Examples

data=data_example1
SLEMI:::func_input_checks(data=data,signal="signal",
response="response",side_variables="sideVar")

# The following examples will give errors, because  the data has 
# inconsistent format for the analysis. Only to check the adequacy of
# initial checks. 
# data=as.matrix(data_example1)
# SLEMI:::func_input_checks(data=data,signal="signal",
# response="response",side_variables="sideVar")
# data=data_example1
# SLEMI:::func_input_checks(data=data,signal="input",
# response="response",side_variables="sideVar")

SLEMI documentation built on Nov. 20, 2023, 1:06 a.m.