Create an mNIRS data frame with Metadata

Manually add class "mnirs.data" and metadata to an existing data frame.

Usage

create_mnirs_data(data, metadata)

Arguments

data

A data frame.

metadata

Metadata passed along with the data frame.

• nirs_device

• nirs_channels

• time_channel

• event_channel

• sample_rate

• event_sample_list

• fit_span

• display_span

• end_kinetics_span

Value

A tibble of class mnirs.data with metadata available with attributes().

Examples

## currently implemented metadata
metadata <- list(nirs_device = NULL,
                 nirs_channels = NULL,
                 time_channel = NULL,
                 event_channel = NULL,
                 sample_rate = NULL,
                 event_sample_list = NULL,
                 fit_span = NULL,
                 display_span = NULL,
                 end_kinetics_span = NULL)

df <- data.frame(A = 1:3,
                 B = seq(10, 30, 10),
                 C = seq(11, 33, 11))
attributes(df)
#> $names
#> [1] "A" "B" "C"
#> 
#> $class
#> [1] "data.frame"
#> 
#> $row.names
#> [1] 1 2 3
#> 

nirs_data <- create_mnirs_data(
    df,
    metadata = list(nirs_channels = c("B", "C"),
                    time_channel = "A",
                    sample_rate = 1)
)
attributes(nirs_data)
#> $class
#> [1] "mnirs.data" "tbl_df"     "tbl"        "data.frame"
#> 
#> $row.names
#> [1] 1 2 3
#> 
#> $names
#> [1] "A" "B" "C"
#> 
#> $nirs_channels
#> [1] "B" "C"
#> 
#> $time_channel
#> [1] "A"
#> 
#> $sample_rate
#> [1] 1
#>