Man pages for mnirs
Muscle Near-Infrared Spectroscopy Processing and Analysis

abort_validationvalidate_numeric abort message construction
accept_port_fitAccept or reject a non-converged port fit
analyse_biexponentialAnalyse biexponential kinetics across NIRS channels
analyse_exponential_driftAnalyse exponential-drift kinetics across NIRS channels
analyse_kineticsAnalyse kinetics across mNIRS channels and intervals
analyse_kinetics_channelsProcess kinetics fits across NIRS channels
analyse_kinetics_intervalsRun a kinetics worker over each interval and collate results
analyse_logisticAnalyse logistic kinetics across NIRS channels
analyse_monoexponentialAnalyse monoexponential kinetics across NIRS channels
analyse_peak_slopeAnalyse peak linear slope across NIRS channels
analyse_response_timeAnalyse fractional kinetics response time across NIRS...
analyse_sigmoidal_driftAnalyse sigmoidal-drift kinetics across NIRS channels
apply_interval_groupsApply grouping to intervals
apply_spanapply span to resolved times and build interval_spec data...
artinis_intervals.xlsx10 Hz Artinis Oxysoft export recorded with Oxymon MKIII
as_data_listCoerce 'data' input to a named list of data frames
as_mnirs_intervalcoerce raw values to mnirs_interval objects
as_plot_dataValidate and bind a list of mnirs data frames for plotting
biexp_coreBiexponential model with gradient
biexp_initInitiate self-starting biexponential model
biexponentialBiexponential function
biexp_startGrid-profiled starting estimates for the biexponential model
breaks_timespanBreaks for time span data
build_fit_resultsAssemble a fitted channel result
build_kinetics_resultsGather per-interval 'mnirs_kinetics' into results structure
build_na_resultsBuild a standardised NA result for a failed channel
build_ss_formulaBuild a self-start model formula with optional fixed...
by_timeSpecify interval boundaries by time, label, lap, or sample
clean_channel_namesClean legend trace names to syntactic column names
clean_cnd_messageFlatten a captured condition message
compute_diagnosticsCompute model diagnostics
compute_helpersComputes rolling local values
convert_typeCoerce column types by role: nirs numeric, event integer,...
correct_blood_volumeCorrect for blood volume changes
count_decimalsCount maximum decimal places across a numeric vector
count_sigfigsCount maximum significant figures across a numeric vector
create_mnirs_dataCreate an _mnirs_ data frame with metadata
detect_directionDetect the direction of a response signal
detect_dttm_formatDetect the first 'dttm_opts' format matching a character...
detect_irregular_samplesReport warnings for unbalanced time_channel samples
detect_mnirs_deviceDetect mnirs device from file metadata
detect_time_channelDetect time_channel from column names or time-formatted...
device_patternsKnown channel names and detection patterns for supported...
dttm_optsDatetime format strings for POSIXct parsing
embed_fit_callMake an nls model call self-contained
enforce_directionEnforce the requested direction on a converged parametric fit
ensemble_intervalsEnsemble average multiple intervals
example_mnirsGet path to _mnirs_ example files
expdrift_initInitiate self-starting exponential-drift model
expdrift_modelExponential-drift model with gradient
expdrift_onsetDrift onset time of the exponential-drift model
expdrift_startGrid-profiled starting estimates for the exponential-drift...
exponential_driftExponential-drift function
extract_df_listExtract interval data by time range
extract_intervalsExtract intervals from _mnirs_ data
extract_start_timestampExtract earliest POSIXct value from file header metadata
filter_butterworthApply a Butterworth digital filter
filter_mnirsFilter a data frame
filter_moving_averageApply a moving average filter
find_header_rowFind the header row containing all 'nirs_channels'
find_interval_timeresolve a single mnirs_interval object to time values
find_kinetics_idxFind valid model-fitting indices up to the first extreme
fit_biexponentialFit a biexponential model to one channel
fit_controlMerge user nls control over a fit's internal defaults
fit_exponential_driftFit an exponential-drift model to one channel
fit_monoexponentialFit a monoexponential model to one channel
fit_namesAlias fit column names that collide with model parameters
fit_sigmoidalFit a sigmoidal model to one channel
fit_sigmoidal_driftFit a sigmoidal-drift model to one channel
fit_td_fallbackFit a self-start model with time-delay fallback
format_hmmssFormat time span data as h:mm:ss
free_paramsFree parameters of a self-start model call
full_coefsCombine fitted and fixed coefficients into the full parameter...
gompertzGompertz growth functions
gompertz_initInitiate self-starting Gompertz model
hms_to_secondsConvert H:MM(:SS.fff) strings to seconds of day
init_asymptotesEstimate baseline and asymptote from the first/last quintile...
init_fixedWrap a self-start initialiser to support fixed parameters
init_inflectionEstimate inflection point from a smoothed first derivative
is_arg_mapClassify a per-channel/per-interval argument map
is_emptyDetect empty or NA strings
kinetics_annotationsBuild per-panel kinetics marker and label annotations
kinetics_warnings_dfZero-row kinetics warnings scaffold
logisticGeneralised logistic function
logistic_initInitiate self-starting logistic model
map_mnirs_intervalsApply an mnirs function over each interval of a...
mnirs_metadataMetadata names of class '"mnirs"', retrieved with 'attr()'
mnirs-packagemnirs: Muscle Near-Infrared Spectroscopy Processing and...
monoexp_initInitiate self-starting monoexponential model
monoexp_modelMonoexponential model with gradient
monoexponentialMonoexponential function
monoexp_startGrid-profiled starting estimates for the monoexponential...
moxy_intervals.csv0.5 Hz Moxy onboard export
moxy_ramp.xlsx2 Hz PerfPro export of Moxy data
name_channelsForce names on character strings
normalise_interval_groupsNormalise custom interval grouping to a complete named list
oxysoft_sample_rateExtract the export sample rate from Oxysoft header metadata
palette_mnirsCustom _mnirs_ colour palette
parse_channel_nameParse channel expressions for NSE
parse_dttmParse character date-times with one 'dttm_opts' format to...
parse_oxysoft_legendParse channel names from the Oxysoft "Legend" metadata block
parse_time_channelParse time_channel character or dttm to numeric seconds
peak_slopePeak linear slope
pionirs_occlusion.ftn1 Hz PIONIRS NIRSBOX export
plot.mnirsPlot _mnirs_ objects
plot.mnirs_kineticsPlot _mnirs_ kinetics results
portamon_oxcap.xlsx10 Hz Artinis Oxysoft export recorded with Portamon
preserve_metadataZero-offset time values and add metadata
preserve_naPreserve and restore NA information within a vector
print.mnirsMethods for mnirs objects
print.mnirs_kineticsMethods for mnirs_kinetics objects
read_fileRead raw data frame from file path
read_mnirsRead _mnirs_ data from file
recycle_paramRecycle parameter to match number of events
recycle_spanrecycle a single-element span to c(start, end) positive ->...
recycle_to_lengthRecycle parameter list to target length
remove_empty_rows_colsRemove Empty Rows and Columns
rename_duplicatesRename duplicate strings in a vector with 'make.unique()'
replace_mnirsReplace outliers, invalid, and missing values in _mnirs_ data
resample_mnirsRe-sample an _mnirs_ data frame
rescale_mnirsRescale data range
resolve_channel_argsResolve per-channel arguments
resolve_channelsResolve channels from user input, device defaults, or the...
resolve_fixed_paramsResolve fixed parameters from a self-start model call
resolve_intervalresolve start/end into time value vectors (no span applied)
resolve_interval_argsResolve per-interval arguments
response_timeFractional response time
rolling_slopeCalculate rolling linear slope
scale_colour_mnirsScales for custom _mnirs_ palette
select_channelsSelect, rename, and order channel columns
seq_rangeGenerate numeric sequence from range of a vector
setup_kinetics_workerShared validation prologue for analyse_<method>() workers
shift_mnirsShift data range
sigdrift_initInitiate self-starting sigmoidal-drift model
sigdrift_modelSigmoidal-drift model with gradient
sigdrift_onsetDrift onset time of the sigmoidal-drift model
sigdrift_rateRate constant of a sigmoidal shape
sigdrift_startStarting estimates for the sigmoidal-drift model
sigdrift_texcExcursion point of the sigmoidal-drift model
sigmoidal_driftSigmoidal-drift function
sigmoid_coreSigmoid curve with gradient
signif_trailingFormat numbers for display as character strings
solve_grid3Batched 3-parameter least squares over a grid
split_kinetics_groupsSplit interval data frames into sample groups
SSbiexponentialSelf-starting biexponential model
SSexponential_driftSelf-starting exponential-drift model
SSgompertzSelf-starting Gompertz models
SSlogisticSelf-starting logistic model
SSmonoexponentialSelf-starting monoexponential model
SSsigmoidal_driftSelf-starting sigmoidal-drift model
theme_mnirsCustom _mnirs_ ggplot2 theme
train.red_intervals.csv10 Hz Train.Red App export
validate_findIntwrap findInterval: informative 'time_channel' error message
validate_fixValidate fixed model parameters
validate_group_channelsValidate and normalise channel grouping
validate_interval_channelsValidate per-group channel selections for ensemble-averaging
validate_kinetics_argsValidate resolved per-channel kinetics arguments
validate_mnirsValidate '{mnirs}' parameters
validate_start_timeValidate start_time
warn_calltrim caller call to bare function name for warning headers...
warn_fit_failedWarn on a failed or non-converged kinetics model fit
warn_map_keysWarn about unmatched keys in an argument map
withinDetect if numeric values fall within range of a vector
wrapWrap vector elements
zero_offset_dataRecalculate time_channel values with zero offset at event...
mnirs documentation built on Sept. 13, 2026, 1:06 a.m.