sim_new: Constructor for 'matric_sim' S3 class.

View source: R/sim_construct-validate.R

sim_newR Documentation

Constructor for matric_sim S3 class.

Description

sim_new creates an object of class matric_sim.

Usage

sim_new(x, row_metadata, metric_metadata)

Arguments

x

data.frame with similarity matrix.

row_metadata

tbl with row metadata.

metric_metadata

list with metric information

Details

matric_sim is just a tibble with two attributes and at least three columns.

Columns:

  • id1 and id2: integers, indicating row ids.

  • sim: double, indicating similarity between the rows.

Attributes:

  • row_metadata: data.frame of row annotations, with id column.

  • metric_metadata: information about the similarity metric.

This is somewhat similar to Biobase::AnnotatedDataFrame.

Value

Object of class matric_sim.


matric documentation built on April 1, 2023, 12:19 a.m.