Autopad zeros

Autopad zeros

Usage

autopadZeros(object, ...)

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

# S4 method for 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.

Value

character.

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.

Note

Updated 2021-09-02.

Examples

data(RangedSummarizedExperiment, package = "AcidTest")

## SummarizedExperiment ====
object <- RangedSummarizedExperiment
autopadZeros(object, rownames = TRUE, colnames = TRUE)
#> class: RangedSummarizedExperiment 
#> dim: 500 12 
#> metadata(3): version date interestingGroups
#> assays(1): counts
#> rownames(500): gene001 gene002 ... gene499 gene500
#> rowData names(10): broadClass description ... ncbiGeneId seqCoordSystem
#> colnames(12): sample01 sample02 ... sample11 sample12
#> colData names(1): condition