run_decoding: A cross-validator (CV) method to run a decoding analysis

Description Usage Arguments Value See Also

View source: R/generic_functions.R

Description

This method runs a full decoding analysis based on the DS, FP, CL, and RM objects that are passed to the cross-validator constructor.

Usage

1
run_decoding(cv_obj)

Arguments

cv_obj

A CV object. Parameters that affect the decoding analyses are set in the CV's constructor.

Value

A list, usually called DECODING_RESULTS, that contains the results from the decoding analysis. This DECODING_RESULTS list should contain the result compiled by the result metric objects, as well as a list in DECODING_RESULTS$cross_validation_paramaters$parameter_df contains data on all that DS, FP, CL and RM parameters that were used in the decoding analysis that can be used to store and retrieve the results. Additionally, the DS, FP, CL and RM objects used in the analysis can be saved in the DECODING_RESULTS$cross_validation_paramaters.

See Also

cv_standard()


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