autopadZeros: Autopad zeros

In acidgenomics/r-acidexperiment: Acid Genomics Summarized Experiment

Autopad zeros

Description

Autopad zeros

Usage

autopadZeros(object, ...)

## S4 method for signature 'SummarizedExperiment'
autopadZeros(
  object,
  rownames = FALSE,
  colnames = TRUE,
  sampleNames = TRUE,
  sort = TRUE
)

## S4 method for signature 'matrix'
autopadZeros(object, rownames = FALSE, colnames = TRUE, sort = TRUE)

Arguments

object	Object.
rownames	logical(1). Apply to row names.
colnames	logical(1). Apply to column names.
sampleNames	logical(1). Applies to SummarizedExperiment method. #' If sampleName column is defined in colData(), these values will also get padded, if necessary. This improves downstream handling in functions that rely on this feature.
sort	logical(1). Resort using sort.
...	Additional arguments.

Details

For methods on objects supporting dim() (e.g. matrix), the object will be returned with the rows and/or columns resorted by default. This does not apply to the character method defined in syntactic.

Value

character.

Note

Updated 2021-09-02.

Examples

data(RangedSummarizedExperiment, package = "AcidTest")

## SummarizedExperiment ====
object <- RangedSummarizedExperiment
autopadZeros(object, rownames = TRUE, colnames = TRUE)

acidgenomics/r-acidexperiment documentation built on Jan. 17, 2024, 7:56 p.m.