get_parameters: Get parameters of an NDTr object

In emeyers/NDTr: The Neural Decoding Toolbox in R

Description

Returns the parameters set in an NDTr object to enable reproducible analyses.

Usage

get_parameters(ndtr_obj)

Arguments

ndtr_obj

An object from the NDTr package to get the parameters from.

Details

This is a generic function that returns a data frame with the parameters of an NDTr object. All NDTr objects (i.e., DS, FP, CL, RM and CV) need to define a method that implements this generic function. The CV object's get_parameters() method usually will call all the DS, FP, CL, RM and CV get_parameters() methods and aggregate and return all the parameters aggregated from these objects. These aggregated parameters can then be used to save the results of a particular analysis based on the parameters using the log_save_results() function. This method is most frequently used privately by other NDTr objects to save all the parameters that were used in an analysis.

Value

Returns a data frame with a single row that contains all the NDTr object's parameter values (e.g., values that were set in the object's constructor).

emeyers/NDTr documentation built on Aug. 8, 2020, 3:41 p.m.