make_dataset_ob: Initialize a dataset object

In kazeera/hourglass: This Package Provides Visualizations of Annotated Numeric Data

Initialize a dataset object

Description

Make a dataset object by specifying 3 main components: 1) values matrix (required), 2) column annotations, 3) row annotations

Usage

make_dataset_ob(
  vals,
  colAnn = NULL,
  rowAnn = NULL,
  name = "",
  remove_outliers = F
)

Arguments

vals	Numeric matrix or data frame of values
colAnn	Column annotations. Data frame that specifies the annotations for each column of vals. Each row defines features for a specific column. The row names should match the column names of vals.
rowAnn	Row annotations. Data frame that specifies the annotations for each row of vals. Each row defines features for a specific row The row names should match the row names of vals.
name	Name of dataset that will be used in plots and so on.
remove_outliers	TRUE or FALSE. Should we remove outliers in vals? (i.e. for each column, only keep points between quartile(Q)1 and Q3)

Value

A dataset object (essentially a list with 4 elements: vals, colAnn, rowAnn, name)

kazeera/hourglass documentation built on April 5, 2025, 7:18 a.m.