Function reference • calmr

All functions

CalmrDesign-class: S4 class for calmr designs

show(<CalmrDesign>) mapping(<CalmrDesign>) trials(<CalmrDesign>): CalmrDesign methods

show(<CalmrExperiment>) design(<CalmrExperiment>) trials(<CalmrExperiment>) parameters(<CalmrExperiment>) `parameters<-`(<CalmrExperiment>) experiences(<CalmrExperiment>) `experiences<-`(<CalmrExperiment>) results(<CalmrExperiment>) raw_results(<CalmrExperiment>) parsed_results(<CalmrExperiment>) length(<CalmrExperiment>) parse(<CalmrExperiment>) aggregate(<CalmrExperiment>) plot(<CalmrExperiment>) graph(<CalmrExperiment>) timings(<CalmrExperiment>) `timings<-`(<CalmrExperiment>): CalmrExperiment methods

CalmrExperiment-class: S4 class for calmr experiments.

CalmrExperimentResult-class: S4 class for calmr experiment results

CalmrFit-class: S4 class for calmr Fit

show(<CalmrFit>) predict(<CalmrFit>) NLL(<CalmrFit>) AIC(<CalmrFit>) BIC(<CalmrFit>): CalmrFit methods

CalmrRSA-class: S4 class for calmr representational similarity analysis

show(<CalmrRSA>) test(<CalmrRSA>) plot(<CalmrRSA>): CalmrRSA methods

show(<CalmrResult>): CalmrResult methods

CalmrResult-class: S4 class for calmr results

rsa(): Perform representational similarity analysis

calmr_model_graph() patch_graphs() get_graph_opts(): Create a graph with calmr data

calmr_model_plot() plot_common_scale() get_plot_opts() patch_plots(): Create a plot with calmr data

calmr_verbosity(): Set verbosity options for calmr

compare_models(): Run models given a set of parameters

fit_model(): Fit model to data

get_design(): Get basic designs

get_optimizer_opts(): Get optimizer options

get_parameters(): Get model parameters

get_timings(): Get timing design parameters

make_experiment(): Make CalmrExperiment

supported_models() supported_timed_models() supported_optimizers() supported_families() supported_plots() get_model() model_parameters() model_outputs(): Model information functions

parse_design(): Parse design data.frame

pati: Rat responses from Patittucci et al. 2016

phase_parser(): Parses a phase string

plot_targetted_tbins() plot_tbins() plot_targetted_trials() plot_trials() plot_targetted_typed_trials() plot_targetted_complex_trials(): General plotting functions

run_experiment(): Run experiment

set_calmr_palette(): Get/set the colour/fill palette for plots

set_reward_parameters(): Set reward parameters for ANCCR model