z_score: Transform values into z scores

Description Usage Arguments Value Examples

View source: R/z_score.R

Description

'z_score' transforms input values to z scores. Allows user input of mu and sigma values for comparing distributions.

Usage

1
2
3
4
5
6
<<<<<<< HEAD
z_score(xvals, mu = NULL, sigma = NULL, summary.type = "mean",
=======
z_score(xvals, mu = NULL, sigma = NULL, metric.type = "mean",
>>>>>>> 9c5f9e9ad16eef4007a67587d64a4996bca3cdf6
  mad.const = 1.4826)

Arguments

xvals

vector of numbers

mu

the population mean

sigma

the population standard deviation

summary.type

the summary statistic to use * "mean" computes standard z scores * "median" computes modified z-scores

mad.const

if median is used, the constant used in computing MAD

Value

a numeric vector of z scores

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
# Format data
df.new <- format_data(GCaMP)

# Split data
basevals <- df.new$Trial1[df.new$Time <= 0]
eventvals <- df.new$Trial1[df.new$Time > 0]

# Find baseline (pre-epoc) values
base.mu <- mean(basevals)
base.sigma <- sd(basevals)

# Compute values
z_score(xvals = eventvals, mu = base.mu, sigma = base.sigma)

atamalu/GCalcium documentation built on July 12, 2019, 7:04 p.m.