Overview of functionality

A UnfoldSim simulation has four ingredients: Design, Component, Onset and Noise. Here we provide a short overview of the implemented types.

Setup

# Load required packages
using UnfoldSim
using InteractiveUtils

Design

Designs define the experimental design. They can be nested, e.g. RepeatDesign(SingleSubjectDesign,10) would repeat the generated design-dataframe 10x.

subtypes(AbstractDesign)

6-element Vector{Any}:
 EffectsDesign
 MultiSubjectDesign
 RepeatDesign
 SequenceDesign
 SingleSubjectDesign
 UnfoldSim.SubselectDesign

Component

Components define a signal. Some components can be nested, e.g. LinearModelComponent|>MultichannelComponent, see the multi-channel tutorial for more information.

subtypes(AbstractComponent)

3-element Vector{Any}:
 LinearModelComponent
 MixedModelComponent
 MultichannelComponent

Onsets

Onsets define the distance between events in the continuous signal.

subtypes(AbstractOnset)

6-element Vector{Any}:
 LogNormalOnset
 LogNormalOnsetFormula
 NoOnset
 ShiftOnsetByOne
 UniformOnset
 UniformOnsetFormula

Noise

Choose the noise you need!

subtypes(AbstractNoise)

7-element Vector{Any}:
 ExponentialNoise
 NoNoise
 PinkNoise
 RedNoise
 UnfoldSim.AutoRegressiveNoise
 UnfoldSim.RealisticNoise
 WhiteNoise

This page was generated using Literate.jl.