r2Z: Convert rate ratios to Z-values

View source: R/CSSA.R

r2ZR Documentation

Convert rate ratios to Z-values

Description

r2Z calculates the Z-values of rate ratios standardized to all rate ratios or a specified normalization subset.

Usage

r2Z(r, normsubset, method = "mean")

Arguments

r

Character vector. List of rate ratios

normsubset

Integer vector. Specify the indices of features that are to be used in standardization

method

Character. Specify what method to use for standardization. Options are "median" and "mean". Default = "mean"

Details

While not strictly required, it is recommended to input log-transformed rate ratios. Standardization is by default done using the mean and standard deviation: (r-mean(r))/sd(r). By specifying method = "median", it does so using the median and median absolute deviations: (r-median(r))/mad(r).

Value

Returns a numeric vector of the same length as the number of rate ratios

Note

Functions in the CSSA package by default return log-transformed rate ratios. These can directly be used as input for this function.

Author(s)

Jos B. Poell

See Also

sumZ, ess, noness


tgac-vumc/CSSA documentation built on Oct. 10, 2022, 7:27 p.m.