soj_3x_original: Invoke the original triaxial Sojourn method

Description Usage Arguments Value Examples

View source: R/soj_3x_original.R

Description

Calls the triaxial Sojourn method from Lyden et al. (2014).

Usage

1
2
3
4
5
6
7
8
soj_3x_original(
  counts,
  counts.2,
  counts.3,
  vect.mag,
  short = 30,
  verbose = FALSE
)

Arguments

counts

numeric vector of activity counts from the first axis

counts.2

numeric vector of activity counts from the second axis

counts.3

numeric vector of activity counts from the third axis

vect.mag

vector magnitude of the activity counts

short

minimum length of one Sojourn

verbose

logical. Print updates to console?

Value

a data frame of processed data

Examples

1
2
3
4
5
6
7
8
9
data(example_data, package = "Sojourn")
results_3x <- soj_3x_original(
  example_data$axis1,
  example_data$axis2,
  example_data$axis3,
  example_data$Vector.Magnitude
)

utils::head(results_3x)

Sojourn documentation built on May 8, 2021, 1:06 a.m.