Table of Contents

• API

  • Tasks

  • Reports

  • Stats

API

Tasks

Heart Beat Counting task

Parameters

getParameters([participant, session, ...])

Create Heartbeat Counting task parameters.

Scripts

run(parameters[, runTutorial])	Run the entire task sequence.
trial(condition, duration, nTrial, parameters)	Run one trial.
tutorial(parameters)	Run tutorial for the Heartbeat Counting Task.
rest(parameters[, duration])	Run a resting state period for heart rate variability before running the Heart Beat Counting Task.

Heart Rate Discrimination task

Parameters

getParameters([participant, session, ...])

Create Heart Rate Discrimination task parameters.

Scripts

run(parameters[, confidenceRating, runTutorial])	Run the Heart Rate Discrimination task.
trial(parameters, alpha, modality[, ...])	Run one trial of the Heart Rate Discrimination task.
waitInput(parameters)	Wait for participant input before continue
tutorial(parameters)	Run tutorial before task run.
responseDecision(this_hr, parameters, ...)	Recording response during the decision phase.
confidenceRatingTask(parameters)	Confidence rating scale, using keyboard or mouse inputs.

Languages

english(device, setup, exteroception)	Create the text dictionary with instruction in Danish
danish(device, setup, exteroception)	Create the text dictionary with instruction in Danish
danish_children(device, setup, exteroception)	Create the text dictionary with instruction in Danish (simplified version for children).
french(device, setup, exteroception)	Create the text dictionary with instruction in french

Reports

report(result_path[, report_path, task, ...])	From the results folders, create HTML reports of behavioural and physiological data.
preprocessing(results)	From the main behavioural data frame, extract summary metrics of behavioural, metacognitive and interoceptive performances.
group_level_preprocessing(results[, ...])	Extrat all relevant indices from large result data frames.

Stats

Extracting the relevant parameters from long result data frame across group / repeated measures.

psychophysics(summary_df[, variables, ...])	Extract psychometric parameters from a set of result files from the HRD task.
behaviours(summary_df[, variables, ...])	Extract behavioural parameters from a set of result files from the HRD task.