is.settings {sectorgap}R Documentation

Settings object validity check

Description

Checks if settings are a valid object of class settings.

Usage

is.settings(x, dfl = NULL, return.logical = FALSE)

Arguments

x

settings object

dfl

list of data frames, returned by function settings_to_df

return.logical

If return.logical = FALSE (default), an error message is printed if the object is not of class settings, if return.logical = TRUE, a logical value is returned

Value

A logical value or nothing, depending on the value of return.logical.


[Package sectorgap version 0.1.0 Index]