Create an mNIRS data frame with metadata

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

Usage

create_mnirs_data(data, ...)

Arguments

data

A data frame with existing metadata retrieved with attributes(data).

...

Additional arguments with metadata to add to the data frame.

• nirs_device

• nirs_channels

• time_channel

• event_channel

• sample_rate

• event_times

• kinetics_method

• kinetics_span

• kinetics_x0

• end_kinetics_span

Value

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

Examples

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"
#>