orderBy: choose the column by which to order the ranges by within each...

orderByR Documentation

choose the column by which to order the ranges by within each group

Description

choose the column by which to order the ranges by within each group

Usage

orderBy(object = "profileplyr", column = "ANY")

## S4 method for signature 'profileplyr'
orderBy(object = "profileplyr", column = "ANY")

Arguments

object

A profileplyr object

column

Which column of mcols(proplyrObject) should be used for ordering the ranges. If NULL removes any previous setting for row ordering.

Details

Takes a profileplyr object and orders the rows based on a user defined metadata column of rowRanges

Value

A profileplyr object

Methods (by class)

  • orderBy(profileplyr): choose the column by which to order the ranges by within each group

Examples

example <- system.file("extdata", "example_deepTools_MAT", package = "profileplyr") 
object <- import_deepToolsMat(example) 

library(SummarizedExperiment)
cluster <- clusterRanges(object, fun = rowMeans, cutree_rows = 3)
cluster_order <- orderBy(cluster, column = "hierarchical_order")
params(cluster_order)$mcolToOrderBy


RockefellerUniversity/profileplyr documentation built on Jan. 28, 2023, 10:09 a.m.