cells: The experimental cells of a design

View source: R/all_generic.R

cellsR Documentation

The experimental cells of a design

Description

return the experimental cells that are in a model term as a table

This function extracts cells from an event_factor object, optionally removing empty cells. Note that the removal of empty cells is not implemented.

This function extracts cells from an event_term object, optionally removing empty cells.

Usage

cells(x, ...)

## S3 method for class 'event_factor'
cells(x, drop.empty = TRUE, ...)

## S3 method for class 'event_term'
cells(x, drop.empty = TRUE, ...)

## S3 method for class 'covariate_convolved_term'
cells(x, ...)

Arguments

x

An event_term object.

...

Additional arguments to be passed to the function.

drop.empty

Logical. If TRUE, empty cells will be removed.

Value

A list of data frames containing the cells of the event_factor object.

A tibble containing the cells of the event_term object, with an additional "count" attribute.

Examples


evlist <- list(fac1=factor(c("A", "B", "A", "B")), 
               fac2=factor(c("1", "1", "2", "2")))
eterm <- event_term(evlist,onsets=1:4, blockids=rep(1,4))
cells(eterm)

bbuchsbaum/fmrireg documentation built on May 16, 2023, 10:56 a.m.