summary.rcorex: Summarise an rcorex object
In jpkrooney/rcorex: An Implementation of Total Correlation Explanation
View source: R/summary.rcorex.R
summary.rcorex R Documentation
Summarise an rcorex object
Description
Summary method for an rcorex object
Usage
## S3 method for class 'rcorex'
summary(object, ...)
Arguments
object
An object of class rcorex
...
Not used
Value
Returns a list with the following model summary parameters:
call - the call used to run corex.
datadim - a vector enumerating the number of rows and columns in the data.
state - whether the model has converged or not.
iters - the number of iterations carried out by rcorex
tcs - a vector of TC for n_hidden variables.
jpkrooney/rcorex documentation built on July 25, 2022, 1:37 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/summary.rcorex.R
| summary.rcorex | R Documentation |
Summarise an rcorex object
Description
Summary method for an rcorex object
Usage
## S3 method for class 'rcorex' summary(object, ...)
Arguments
object |
An object of class rcorex |
... |
Not used |
Value
Returns a list with the following model summary parameters:
call - the call used to run corex.
datadim - a vector enumerating the number of rows and columns in the data.
state - whether the model has converged or not.
iters - the number of iterations carried out by rcorex
tcs - a vector of TC for n_hidden variables.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.