standardize-methods: #' Summary of an ExposomeSet. #' #' Given an ExposomeSet is...

standardizeR Documentation

#' Summary of an ExposomeSet. #' #' Given an ExposomeSet is shows a summary for its exposures or #' its phenotypes. #' #' @name Summary #' @rdname Summary-methods #' @aliases Summary #' @param object codeExposomeSet with 'set' will be summarized. #' @param set Set to be sumarized ("exposures" or "phenotypes"). #' @param select Subseting of exposures of phenotypes. #' @return A basic description of the exposures in the ExposomeSet #' @examples #' data("exposome") #' Summary(expo, set = "exposures") #' @export Summary setGeneric("Summary", function(object, set=c("exposures", "phenotypes"), select) standardGeneric("Summary") ) Standardize of an ExposomeSet.

Description

Given an ExposomeSet it standardizes the exposures by using mean/sd if method is "normal" or by using median/mad if method is "robust".

Usage

standardize(object, select, method = "normal", na.rm = TRUE, warnings = TRUE)

Arguments

object

ExposomeSet with exposures to be standardized.

select

Subseting of exposures of phenotypes.

method

(default "normal") Character selecting the method to be applied ("normal" "iqr" or "robust").

na.rm

(by default TRUE) Removes NA data to perform standardization.

warnings

(defaulr TRUE) If set to FALSE warnings are not shown.

Value

An ExposomeSet with the selected exposures standardized and keeping the others exposures as the original input object.

See Also

highAndLow to transform the continuous exposures to levelled factors, trans to transform the exposures

Examples

data("exposome")
exp.sn <- standardize(expo, method = "normal", select = "lbde100_lip")
exp.rs <- standardize(expo, method = "iqr", select = "lbde100_lip")
exp.rs <- standardize(expo, method = "robust", select = "lbde100_lip")

isglobal-brge/rexposome documentation built on Feb. 4, 2023, 12:35 p.m.