Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

  • f270c57
  • /
  • R
  • /
  • adjustDataset.R
Raw File Download
Permalinks

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
content badge Iframe embedding
swh:1:cnt:d4bac74dbb8d7d5c92f9143345e96de126bec72c
directory badge Iframe embedding
swh:1:dir:6dd4b3f64d06ebfde201beadc02277047cc9ff0a
Citations

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
adjustDataset.R
#' Adjust dataset
#'
#' @param es Expression set to perform adjustment on
#'
#' @param scaleColumnSum perform sum scaling of columns (default FALSE)
#'
#' @param log2 perform logarithm2 adjustment (default FALSE)
#'
#' @param onePlusLog2 perform log2(1+x) adjustment (default FALSE)
#'
#' @param inverseLog2 perform 2^x adjustment (default FALSE)
#'
#' @param quantileNormalize perform quantile normalization (default FALSE)
#'
#' @param zScore perform zScore adjustment:
#'  subtract mean, divide by std (default FALSE)
#'
#' @param robustZScore perform robustZScore adjustment:
#'  subtract median, divide by MAD (default FALSE)
#'
#' @param sweep perform sweep adjustment on rows/columns (default FALSE)
#'
#' @return Nothing. Adjusted dataset will be assigned as ES in global environment
#'
#' @import stats
#'
#' @examples
#' \dontrun{
#' es <- gseGSE('GSE53986')[[1]]
#' adjustDataset(es, log2 = T, quantileNormalize = T)
#' }
#'

adjustDataset <- function (es, scaleColumnSum = NULL,
                           log2 = FALSE, onePlusLog2 = FALSE,
                           inverseLog2 = FALSE, quantileNormalize = FALSE,
                           zScore = FALSE, robustZScore = FALSE, sweep = NULL) {

    if (length(scaleColumnSum) > 0 && is.numeric(scaleColumnSum)) {
        sum <- apply(exprs(es), 2, sum, na.rm = TRUE)
        sum <- t(scaleColumnSum / sum)
        exprs(es) <- sweep(exprs(es), 2, sum, "*")
    }

    if (log2) {
        m <- exprs(es)
        # ignore warning for log x when x < 0
        exprs(es) <- ifelse(m < 0 | is.na(m), 0, suppressWarnings(log2(m)))
    }

    if (onePlusLog2) {
        m <- exprs(es)
        # ignore warning for log x when x < 0
        exprs(es) <- ifelse(m < 0 | is.na(m), 0, suppressWarnings(log2(m + 1)))
    }

    if (inverseLog2) {
        m <- exprs(es)
        exprs(es) <- 2^m
    }

    if (quantileNormalize) {
        exprs(es) <- normalizeBetweenArrays(exprs(es), method = 'quantile')
    }

    if (zScore) {
        exprs(es) <- t(scale(t(exprs(es))))
    }

    if (robustZScore) {
        medians <- apply(exprs(es), 1, median)
        exprs(es) <- sweep(exprs(es), 1, medians, "-")
        mads <- apply(exprs(es), 1, mad)
        exprs(es) <- sweep(exprs(es), 1, mads, "/")
    }

    if (length(sweep) > 0) {
        if (sweep$mode == 'row') {
            margin <- 1
            target <- fData(es)[[sweep$name]]
        } else {
            margin <- 2
            target <- phenoData(es)[[sweep$name]]
        }

        exprs(es) <- sweep(exprs(es), margin, target, sweep$op)
    }

    assign("es", es, envir = parent.frame())
}

Software Heritage — Copyright (C) 2015–2025, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Contact— JavaScript license information— Web API

back to top