class.dataset: The 'dataset' class.
In Don-Li/CAB: The Computational Analysis of Behaviour

Description Usage Slots Custom dataset class See Also

In the CAB package, experimental data that is imported for analysis is stored in an analysis_object or one of its child classes (class.analysis_object. For the analysis of experimental data, each session should be stored in separate analysis_objects and these analysis_objects are in turn contained in a dataset object.

1
2
3

set.custom_dataset(class_name, slotnames)

make.custom_dataset_object(dataset_class, ...)

meta_data: A data.frame that contains the information about each element (i.e. experimental session) in the analysis_objects slot.
analysis_object: A list, where each element is an analysis_object.

Custom `dataset` class

If the user wishes to construct their own dataset class, the set.custom_dataset() function can be used.

To create an object of the newly set dataset child class, the make.custom_dataset_object() function can be used. #'

Usage

set.custom_dataset( class_name, slot_names )

Mandatory slots

analysis_objects: Inherited from analysis_object.
meta_data: Inherited from meta_data.

Arguments

class_name: A character string giving the name of the custom dataset child class.
slot_names: Either: 1) an unnamed list of slot names or 2) a named list, with the names specifying the slot names and the elements specifying the class of object contained in the slot. If 1), all slots will contain list.

Usage

make.custom_dataset_object( dataset_class, ... )

Arguments

dataset_class: A character string specifying the name of the custom dataset class.
...: A named set of arguments that fills up the object. The arguments should be named as the slot name to which the argument pertains to.

analysis_object For analogous examples for the usage of set.custom_dataset and make.custom_dataset_object. import_medpc_to_UOA

Don-Li/CAB documentation built on May 6, 2019, 2:52 p.m.