Description Usage Arguments Details Value Examples
View source: R/cppbaseline_array.R
Provides five methods to baseline an array and calculate contrast.
1 2 3 4 5 6 7  baseline_array(
x,
along_dim,
baseline_indexpoints,
unit_dims = seq_along(dim(x))[along_dim],
method = c("percentage", "sqrt_percentage", "decibel", "zscore", "sqrt_zscore")
)

x 
array (tensor) to calculate contrast 
along_dim 
integer range from 1 to the maximum dimension of 
baseline_indexpoints 
integer vector, which index points are counted
into baseline window? Each index ranges from 1 to 
unit_dims 
integer vector, baseline unit: see Details. 
method 
character, baseline method options are:

Consider a scenario where we want to baseline a bunch of signals recorded
from different locations. For each location, we record n
sessions.
For each session, the signal is further decomposed into frequencytime
domain. In this case, we have the input x
in the following form:
session x frequency x time x location
Now we want to calibrate signals for each session, frequency and location using the first 100 time points as baseline points, then the code will be
baseline_array(x, along_dim=3, 1:100, unit_dims=c(1,2,4))
along_dim=3
is dimension of time, in this case, it's the
third dimension of x
. baseline_indexpoints=1:100
, meaning
the first 100 time points are used to calculate baseline.
unit_dims
defines the unit signal. Its value c(1,2,4)
means the unit signal is per session (first dimension), per frequency
(second) and per location (fourth).
In some other cases, we might want to calculate baseline across frequencies
then the unit signal is frequency x time, i.e. signals that share the
same session and location also share the same baseline. In this case,
we assign unit_dims=c(1,4)
.
There are five baseline methods. They fit for different types of data. Denote z is an unit signal, z_0 is its baseline slice. Then these baseline methods are:
"percentage"
(z / mean(z_0)  1) x 100%
"sqrt_percentage"
(sqrt(z) / mean(sqrt(z_0))  1) x 100%
"decibel"
10 * ( log10 (z)  mean( log10(z_0) ) )
"zscore"
(z  mean( z_0 )) / sd( z_0 )
"sqrt_zscore"
(sqrt(z)  mean( sqrt(z_0) )) / sd( sqrt(z_0) )
Contrast array with the same dimension as x
.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46  library(dipsaus)
set.seed(1)
# Generate sample data
dims = c(10,20,30,2)
x = array(rnorm(prod(dims))^2, dims)
# Set baseline window to be arbitrary 10 timepoints
baseline_window = sample(30, 10)
#  baseline percentage change 
# Using base functions
re1 < aperm(apply(x, c(1,2,4), function(y){
m < mean(y[baseline_window])
(y/m  1) * 100
}), c(2,3,1,4))
# Using dipsaus
re2 < baseline_array(x, 3, baseline_window, c(1,2,4),
method = 'percentage')
# Check different, should be very tiny (double precisions)
range(re2  re1)
# Check speed for large dataset
if(interactive()){
dims = c(200,20,300,2)
x = array(rnorm(prod(dims))^2, dims)
# Set baseline window to be arbitrary 10 timepoints
baseline_window = seq_len(100)
f1 < function(){
aperm(apply(x, c(1,2,4), function(y){
m < mean(y[baseline_window])
(y/m  1) * 100
}), c(2,3,1,4))
}
f2 < function(){
# equivalent as bl = x[,,baseline_window, ]
#
baseline_array(x, along_dim = 3,
baseline_indexpoints = baseline_window,
unit_dims = c(1,2,4), method = 'sqrt_percentage')
}
microbenchmark::microbenchmark(f1(), f2(), times = 3L)
}

Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.