Skip to contents

All functions

BSpline()
B-spline basis
Fcontrasts()
Compute F-contrasts
Ident()
Ident
Poly()
Polynomial basis
RobustScale()
Robust Scaling (Median/MAD)
Scale()
Z-score (global) basis
ScaleWithin()
Z-score within groups
Standardized()
Standardized basis
baseline()
Create a Baseline Specification
baseline_model()
Construct a Baseline Model
baseline_terms()
Extract baseline terms
basis_suffix()
Create Basis Function Suffix
block()
Create a Block Variable
cells()
Extract cells from a design object
check_collinearity()
Check design matrix for multicollinearity
column_contrast()
Column Contrast Specification
column_groups_by_condition()
Group column indices by condition for a term/basis pair
columns()
Extract columns
condition_basis_list()
Convert an event_term to a per-condition basis list
conditions()
Extract conditions from a design object
construct()
Construct method
contrast()
Contrast Specification
contrast_set()
Create a Set of Contrasts
contrast_weights()
Unit Contrast Weights
contrasts()
Extract contrasts
contrasts(<event_model>)
Retrieve contrast definitions for an event model
contrasts(<event_term>)
Retrieve contrast definitions for an event term
contrasts(<hrfspec>)
Retrieve contrast specifications from an hrfspec
convolve()
Convolve events with a hemodynamic response function
convolve_design()
Convolve HRF with Design Matrix.
correlation_map()
Compute correlation map
correlation_map(<baseline_model>)
correlation_map.baseline_model
correlation_map(<event_model>)
Visualize Regressor Correlations
covariate()
Construct a Covariate Term
design_map()
Compute design map
design_map(<baseline_model>)
Heatmap visualization of the baseline_model design matrix
design_map(<event_model>)
Visualize Event Model Design Matrix
design_matrix()
Extract or construct a design matrix
elements()
Extract elements from an object
event_basis()
Create an event set from a ParametricBasis object.
event_conditions()
Retrieve per-event condition assignments
event_factor()
Create a categorical event sequence from a factor.
event_matrix()
Create a continuous event set from a matrix.
event_model()
Generic functions for fmridesign package
event_table()
Extract event table
event_term()
Create an event model term from a named list of variables.
event_terms()
Extract event terms
event_variable()
Create a continuous event sequence from a numeric vector.
events()
Retrieve canonical event information
feature_suffix()
Create Feature Suffix
get_all_external_hrf_functions()
Get All External HRF Function Names
get_external_hrfspec_functions()
Get the HRF Function Name for External Specifications
get_external_hrfspec_info()
Get Information About a Registered External HRF Specification
hrf()
hemodynamic regressor specification function for model formulas.
interaction_contrast()
Interaction Contrast
is_categorical()
Check if categorical
is_continuous()
Check if continuous
is_external_hrfspec()
Check if a Class is a Registered External HRF Specification
labels(<event>)
Get Formatted Labels for a Single Event
levels(<Scale>) levels(<ScaleWithin>) levels(<RobustScale>) levels(<event>) columns(<event>)
Extract Levels from fmrireg Objects
list_external_hrfspecs()
List All Registered External HRF Specifications
longnames()
Extract longnames
nbasis(<BSpline>) nbasis(<Poly>) nbasis(<Scale>) nbasis(<ScaleWithin>) nbasis(<RobustScale>) nbasis(<Standardized>) nbasis(<Ident>) nbasis(<covariate_convolved_term>)
Number of Basis Functions
nbasis(<hrfspec>)
Get number of basis functions from hrfspec
nuisance()
Create a Nuisance Specification
one_against_all_contrast()
One Against All Contrast
oneway_contrast()
One-way Contrast
pair_contrast()
Pair Contrast
pairwise_contrasts()
Pairwise Contrasts
plot(<event_model>)
Plot Event Model
plot_contrasts()
plot_contrasts
plot_contrasts(<event_model>)
plot_contrasts.event_model
poly_contrast()
Polynomial Contrast
predict(<ParametricBasis>) predict(<Standardized>) predict(<Poly>) predict(<BSpline>) predict(<Ident>) predict(<Scale>) predict(<ScaleWithin>) predict(<RobustScale>)
Predict from a ParametricBasis object
print(<baseline_model>) print(<contrast_set>) print(<contrast_spec>) print(<contrast>) print(<poly_contrast_spec>) print(<contrast_diff_spec>) print(<event>) print(<event_model>) print(<fmri_term>) print(<convolved_term>) print(<event_term>)
Print a Baseline Model
register_hrfspec_extension()
Register an External HRF Specification Type
regressors()
Extract regressors
requires_external_processing()
Check if an Object Requires External Processing
sanitize()
Sanitize Strings for Use in R Names
shortnames()
Extract shortnames
sliding_window_contrasts()
Sliding-Window Contrasts (Disjoint)
split_by_block()
Split by block
split_onsets()
Split onsets
sub_basis()
sub_basis
term_indices()
Extract term indices
term_matrices()
Extract term matrices
term_names()
Extract term names
trialwise()
trialwise
unit_contrast()
Unit Contrast
validate_contrasts()
Validate contrast weights against a design matrix or event model