Package: PhysioExperiment 2.3.1

Yusuke Matsui

PhysioExperiment: Shared Data Model for Physiological Signal Analysis

Provides the shared data model for the Physio ecosystem: the PhysioExperiment class, a 'SummarizedExperiment' extension for multi-modal physiological signal data (such as electroencephalography, electromyography, and electrocardiography), together with the containers for multiple simultaneously recorded streams, repeated sessions of one subject, and cohorts of subjects. Includes core accessors, channel and event management, provenance, and basic 'S4' methods. Domain packages apply specialized methods to these shared containers and are installed separately.

Authors:Yusuke Matsui [aut, cre]

PhysioExperiment_2.3.1.tar.gz
PhysioExperiment_2.3.1.zip(r-4.7-any)PhysioExperiment_2.3.1.zip(r-4.6-any)PhysioExperiment_2.3.1.zip(r-4.5-any)
PhysioExperiment_2.3.1.tgz(r-4.6-any)PhysioExperiment_2.3.1.tgz(r-4.5-any)
PhysioExperiment_2.3.1.tar.gz(r-4.7-any)PhysioExperiment_2.3.1.tar.gz(r-4.6-any)
PhysioExperiment_2.3.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
PhysioExperiment/json (API)

# Install 'PhysioExperiment' in R:
install.packages('PhysioExperiment', repos = c('https://x-biosignal.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/x-biosignal/physioexperiment/issues

On CRAN:

Conda:

softwareinfrastructuredatarepresentationtimecourse

4.82 score 22 packages 182 exports 21 dependencies

Last updated from:e65059e55e. Checks:7 NOTE, 2 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develNOTE235
source / vignettesOK247
linux-releaseNOTE274
macos-releaseNOTE253
macos-oldrelNOTE228
windows-develNOTE180
windows-releaseNOTE236
windows-oldrelNOTE290
wasm-releaseOK106

Exports:.fitMVAR.mvarSpectraladdEventsaddProvenanceaddSessionaddSubjectaggregatePhysioFeaturesaggregateTrialsaggregateTrialWaveformsalignmentalignment<-alignStreamsAnalysisResultappendProvenanceapplyMontageas.data.frameasMSKTrackerasMultiAssayExperimentassaySamplingRatesavailableOperationsavailableReadersavailableWritersbiomarkerValueblandAltmancbindPhysiochangeScoreschannelInfochannelInfo<-channelNameschannelNames<-checkNAcircularLinearCorrelationcircularSummarycohensDcohortDatacohortData<-cohortDesigncohortTrialscommonClockdefaultAssaydeprecate_physiodesigndesign<-detectGapsdropChannelsdurationelapsedBetweenTrialsestimandOfestimateOfetaSquaredeventQueryexperimentsexperiments<-extractTrialFeaturesextractWindowfillEdgeNAfilterTypefilterValuefPCAgetChannelsByTypegetElectrodePositionsgetEventsgetOperationgetReadergetReferencegetWritergroupshandleNAharmonizeharmonizeChannelsharmonizeMontageharmonizeReferenceharmonizeReporthasMeasuredTimeshasNAiccis.PhysioBiomarkerlogStepmdcmigrateContainermodalitiesMultiPhysioExperimentMultiRatePhysioExperimentmvarFitmvarOrderSelectmvarTransfernaSummarynChannelsnEventsnModalitiesnormativeLookupNormativeReferencenStreamsnSubjectspercentPredictedphysioBiomarkerPhysioBiomarkerPhysioCohortPhysioEventsPhysioExperimentPhysioLongitudinalphysioPalettepickChannelsprovenanceprovenance<-provenanceHashprovenanceOfrayleighTestrbindPhysioreadPhysioRDSreconstructFPCArecordActivityrecordingMaprecordingMap<-recordingsregisterCurvesregisterOperationregisterReaderregisterWriterremoveEventsrenameChannelsreplaceNAresampleToCommonresolveQueryresultTyperesultValuesamplesToTimesamplingRatesamplingRate<-samplingRatesscale_color_physioscale_colour_physioscale_fill_physiosemsessionsessionssessions<-setAssaySamplingRatesetChannelTypessetChannelUnitssetElectrodePositionssetEventssetReferenceshowstreamCoveragestreamNamesstreamRatesstreamsstreams<-streamTimeIndexsubjectsubjectDatasubjectData<-subjectIdssubjectssubjects<-subjectTrialssubsetCohortsummarytheme_physiotimeIndextimeToSamplestimeWindowtrialtrialCoveragetrialIntervalstrialIntervals<-trialstrials<-trialSetuncertaintyOfunregisterOperationunregisterReaderunregisterWriterupdateObjectwatsonWilliamsTestwaveformCMCwaveformICCwaveformReliabilitywithProvenancewpliEstimatezScore

Dependencies:abindBiobaseBiocGenericscliDelayedArraydigestgenericsGenomicRangesIRangeslatticelifecycleMatrixMatrixGenericsmatrixStatsrlangS4ArraysS4VectorsSeqinfoSparseArraySummarizedExperimentXVector

Event Handling in PhysioExperiment
Introduction | The PhysioEvents Class | Creating Events | Default Values | Inspecting Events | Attaching Events to PhysioExperiment | Setting Events from a Data Frame | Retrieving Events | Adding Events | Removing Events | Time and Sample Conversion | Working with Event Windows | Events and Time Concatenation | Summary | Session Info

Last update: 2026-10-03
Started: 2026-10-03

Getting Started with PhysioExperiment
Introduction | Creating a PhysioExperiment | Multiple Assays | Accessing Basic Properties | Sampling Rate | Dimensions and Duration | Default Assay | Channel Management | Reading Channel Information | Setting Channel Properties | Subsetting Channels | Reference Electrode | Subsetting and Combining | Time-based Subsetting | Combining Objects | Summary Statistics | NA Handling | Next Steps | Session Info

Last update: 2026-10-03
Started: 2026-10-03

Readme and manuals

Help Manual

Help pageTopics
Subset a MultiPhysioExperiment by time and stream[,MultiPhysioExperiment,ANY,ANY,ANY-method
Subset PhysioExperiment by time indices[,PhysioExperiment,ANY,ANY,ANY-method
Add events to a PhysioExperiment objectaddEvents
Append a provenance step, capturing an optional seedaddProvenance
Add a session to a PhysioLongitudinaladdSession
Add a subject to a PhysioCohortaddSubject
Aggregate features through trial, session, subject and cohort levelsaggregatePhysioFeatures
Aggregate per-trial features, choosing what counts as a trialaggregateTrials
Align and average trial waveforms through the experimental hierarchyaggregateTrialWaveforms
Align all streams to the reference ratealignStreams
Construct an AnalysisResultAnalysisResult
Accessors for analysis resultsAnalysisResult-accessors biomarkerValue biomarkerValue,PhysioBiomarker-method resultType resultType,AnalysisResult-method resultValue resultValue,AnalysisResult-method resultValue,PhysioBiomarker-method
Estimand / uncertainty carrier accessorsAnalysisResult-carrier estimandOf estimandOf,AnalysisResult-method estimateOf estimateOf,AnalysisResult-method provenanceOf provenanceOf,AnalysisResult-method uncertaintyOf uncertaintyOf,AnalysisResult-method
AnalysisResult: a uniform container for ecosystem analysis outputsAnalysisResult-class show,AnalysisResult-method
Append a provenance activityappendProvenance
Apply standard montageapplyMontage
Coerce to data.frameas.data.frame,PhysioExperiment-method
Coerce a PhysioBiomarker to a one-row data.frameas.data.frame.PhysioBiomarker
Bridge a longitudinal container to a PhysioMSKNet trackerasMSKTracker
Coerce a PhysioLongitudinal to a MultiAssayExperimentasMultiAssayExperiment
Per-assay sampling ratesassaySamplingRates
Bland-Altman Analysis for Method AgreementblandAltman
Combine PhysioExperiment objects by channelscbindPhysio
Per-visit change scores across a longitudinal containerchangeScores
Channel information management for PhysioExperimentchannelInfo
Set channel informationchannelInfo<-
Get channel names/labelschannelNames
Set channel names/labelschannelNames<-
Check for NA values in assay datacheckNA
Mardia's circular-linear correlationcircularLinearCorrelation
Circular mean direction and spreadcircularSummary
Cohen's d Effect SizecohensD
Subject-level metadata table of a PhysioCohortcohortData cohortData,PhysioCohort-method cohortData<- cohortData<-,PhysioCohort-method
Long design table of a cohort (subjects x sessions)cohortDesign
Every trial in a cohortcohortTrials
The shared clockcommonClock
Retrieve the default assay namedefaultAssay
Emit a Physio-ecosystem deprecation warning or errordeprecate_physio
The design schema of a PhysioLongitudinaldesign,PhysioLongitudinal-method design<-,PhysioLongitudinal-method
Gaps in a series of sample timesdetectGaps
Dim method for PhysioExperimentdim,PhysioExperiment-method
Drop channelsdropChannels
Get signal durationduration
Elapsed time between two trialselapsedBetweenTrials
Eta-Squared Effect SizeetaSquared
Create an EventQuery from a PhysioExperimenteventQuery
EventQuery class for composable event filteringEventQuery-class
Extract scalar trial features across sessions and participantsextractTrialFeatures
Extract time windowextractWindow
Fill NA values at edgesfillEdgeNA
Filter events by typefilterType
Filter events by valuefilterValue
Format a PhysioBiomarker as a compact stringformat.PhysioBiomarker
Functional Data Analysis (FDA) for BiomechanicsfPCA
Get channels by typegetChannelsByType
Get electrode positionsgetElectrodePositions
Get events from a PhysioExperiment objectgetEvents
Get reference electrodegetReference
Handle NA values in signal datahandleNA
Harmonize channels, reference and montage across sessionsharmonize
Harmonize channels across sessionsharmonizeChannels
Harmonize the montage across sessionsharmonizeMontage
Harmonize the reference across sessionsharmonizeReference
Report the channels dropped / renamed per session by harmonizationharmonizeReport
Does a stream carry measured sample times?hasMeasuredTimes
Check if data contains any NA valueshasNA
Intraclass Correlation Coefficient (ICC)icc
Test whether an object is a PhysioBiomarkeris.PhysioBiomarker
Length method for PhysioExperimentlength,PhysioExperiment-method
Record an analysis step in the provenance loglogStep
Minimal Detectable Change (MDC)mdc
Convert a pre-unification multimodal containermigrateContainer updateObject,MultiPhysioExperiment-method
Legacy accessors for the multimodal containeralignment alignment,MultiPhysioExperiment-method alignment<- alignment<-,MultiPhysioExperiment-method experiments experiments,MultiPhysioExperiment-method experiments<- experiments<-,MultiPhysioExperiment-method modalities modalities,MultiPhysioExperiment-method multiphysio-legacy-accessors nModalities nModalities,MultiPhysioExperiment-method samplingRates samplingRates,MultiPhysioExperiment-method
Construct a MultiPhysioExperimentMultiPhysioExperiment MultiRatePhysioExperiment
Multimodal container for PhysioExperiment streamsMultiPhysioExperiment-class
Display, size and stream-extraction methods for MultiPhysioExperimentdim,MultiPhysioExperiment-method length,MultiPhysioExperiment-method MultiPhysioExperiment-methods names,MultiPhysioExperiment-method show,MultiPhysioExperiment-method [[,MultiPhysioExperiment,ANY,ANY-method
Legacy multi-rate containerMultiRatePhysioExperiment-class
Fit an MVAR model (user-facing)mvarFit
MVAR model-order selection by AIC / BICmvarOrderSelect
MVAR transfer function and spectra (user-facing)mvarTransfer
Get NA summary for all assaysnaSummary
Get number of channelsnChannels
Get number of eventsnEvents
Look up normative values for a biomarkernormativeLookup
Construct a NormativeReferenceNormativeReference
NormativeReference: stratified normative values for a metricNormativeReference-class show,NormativeReference-method
Normative comparisons for an observed valueNormativeReference-compare percentPredicted percentPredicted,NormativeReference-method zScore zScore,NormativeReference-method
Number of streamsnStreams
Construct a reliability-characterised biomarkerphysioBiomarker
Construct a PhysioBiomarkerPhysioBiomarker
PhysioBiomarker: a single computed biomarker with metadataPhysioBiomarker-class show,PhysioBiomarker-method
Construct a PhysioCohortPhysioCohort
Multi-subject cohort / study containerPhysioCohort-class
Size, subsetting and display for PhysioCohortlength,PhysioCohort-method PhysioCohort-methods show,PhysioCohort-method [,PhysioCohort,ANY,ANY,ANY-method
Create a PhysioEvents objectPhysioEvents
Event management for PhysioExperimentPhysioEvents-class
Construct a PhysioExperiment objectPhysioExperiment
PhysioExperiment class definitionPhysioExperiment-class
Construct a PhysioLongitudinal containerPhysioLongitudinal
Longitudinal subject/session containerPhysioLongitudinal-class
Display, size and subsetting for PhysioLongitudinallength,PhysioLongitudinal-method PhysioLongitudinal-methods show,PhysioLongitudinal-method [,PhysioLongitudinal,ANY,ANY,ANY-method
Colorblind-safe palettes (qualitative, sequential, diverging)physioPalette
Pick specific channelspickChannels
Print fPCA resultprint.fpca_result
Provenance / audit trail for PhysioExperiment objectsprovenance provenance,MultiPhysioExperiment-method provenance,PhysioCohort-method provenance,PhysioExperiment-method provenance,PhysioLongitudinal-method provenance<- provenance<-,PhysioExperiment-method
Deterministic hash of the provenance audit trailprovenanceHash
Rayleigh test for a preferred directionrayleighTest
Combine PhysioExperiment objects by timerbindPhysio
Read a saved object, migrating a pre-unification containerreadPhysioRDS
Reconstruct waveforms from fPCAreconstructFPCA
Record a PROV activity around an operationrecordActivity
How trials map onto recordingsrecordingMap recordingMap<-
The recordings held by a trial setrecordings
Curve registration (time warping)registerCurves
Register and dispatch named operationsavailableOperations getOperation registerOperation unregisterOperation
Register and dispatch file readersavailableReaders getReader registerReader unregisterReader
Register and dispatch file writersavailableWriters getWriter registerWriter unregisterWriter
Remove events from a PhysioExperiment objectremoveEvents
Rename channelsrenameChannels
Replace NA values in assayreplaceNA
Resample all streams onto a single common-rate viewresampleToCommon
Resolve an EventQuery to get filtered eventsresolveQuery
Convert sample indices to timessamplesToTime
Accessors for PhysioExperimentsamplingRate samplingRate,PhysioExperiment-method samplingRate<- samplingRate<-,PhysioExperiment-method
Colorblind-safe discrete colour / fill scales for ggplot2scale_color_physio scale_colour_physio scale_fill_physio
Standard Error of Measurement (SEM)sem
Retrieve a single session by visit label or idsession
Access the sessions of a PhysioLongitudinalsessions sessions,PhysioLongitudinal-method sessions<- sessions<-,PhysioLongitudinal-method
Set the sampling rate of a specific assaysetAssaySamplingRate
Set channel typessetChannelTypes
Set channel unitssetChannelUnits
Set electrode positionssetElectrodePositions
Set events for a PhysioExperiment objectsetEvents
Set reference electrodesetReference
Show method for PhysioEventsshow,PhysioEvents-method
S4 Methods for PhysioExperimentshow,PhysioExperiment-method
Coverage of a time span by a stream's samplesstreamCoverage
Names of the streamsstreamNames
Per-stream sampling ratesstreamRates
Access the streams of a MultiPhysioExperimentstreams streams,MultiPhysioExperiment-method streams<- streams<-,MultiPhysioExperiment-method
Sample times of a stream on the shared clockstreamTimeIndex
Retrieve a single subject's longitudinal record by idsubject
Subject-level metadatasubjectData subjectData,PhysioLongitudinal-method subjectData<- subjectData<-,PhysioLongitudinal-method
Subject ids, subject count and group labels of a PhysioCohortgroups nSubjects subjectIds
Subjects of a PhysioCohortsubjects subjects,PhysioCohort-method subjects<- subjects<-,PhysioCohort-method
Every trial of one subject, across sessionssubjectTrials
Subset a PhysioCohort by group (or a predicate on colData)subsetCohort
Summary statistics for PhysioExperimentsummary,PhysioExperiment-method
A clean, accessible ggplot2 theme for x-biosignal figurestheme_physio
Time index helpertimeIndex
Convert event times to sample indicestimeToSamples
Select a time window across all streamstimeWindow
Extract one trialtrial
Coverage of one trial across every stream it namestrialCoverage
Trial intervals on a streamtrialIntervals trialIntervals<-
Trials recorded in a containertrials trials<-
Hold several independently recorded trials togethertrialSet
Watson-Williams test for equal mean directionswatsonWilliamsTest
Coefficient of multiple correlation for repeated waveforms (Kadaba CMC)waveformCMC
Pointwise intraclass correlation across the movement cyclewaveformICC
Waveform reliability report: CMC, ICC / SEM / MDC curveswaveformReliability
Carry a provenance log onto a derived object and record a stepwithProvenance
Weighted phase-lag index estimator (raw and debiased)wpliEstimate