get_data.ds_basic: A datasource (DS) method to generate training and test sets

View source: R/ds_basic.R

get_data.ds_basicR Documentation

A datasource (DS) method to generate training and test sets

Description

This is a function that must be implemented by all DS objects. This method should not be called directly but instead it is used internally by the cross-validator (CV) object.

Usage

## S3 method for class 'ds_basic'
get_data(ds_obj)

Arguments

ds_obj

The datasource object.

Value

This method returns a data frame where each row corresponds to a data from one time point on a single trial.

  • train_labels: The labels that should be used when training the classifier.

  • test_labels: The labels that should be used when the classifier is tested. Note, this can be different than the training labels when remapping the data using the ds_generalization() data source.

  • time_bin: The time bin where the data point came from.

  • site_XXXX: A set of columns with neural activity from each site.

  • CV_XX: A set of columns that indicate for each cross-validation split whether a data point belongs to the training or test set.

See Also

ds_basic(), ds_generalization()


emeyers/NeuroDecodeR documentation built on March 17, 2024, 6:05 p.m.