PHom: Persistence Data Container

In rrrlw/ripserr: Calculate Persistent Homology with Ripser-Based Engines

Persistence Data Container

Description

PHom() creates instances of PHom objects, which are convenient containers for persistence data. Generally, data frame (or similar) objects are used to create PHom instances with users specifying which columns contain dimension, birth, and death details for each feature.

Usage

PHom(x, dim_col = 1, birth_col = 2, death_col = 3)

Arguments

x	object used to create PHom instance
dim_col	either integer representing column index for feature dimension data or character representing column name
birth_col	either integer representing column index for feature birth data or character representing column name
death_col	either integer representing column index for feature death data or character representing column name

Value

PHom instance

Examples

# construct data frame with valid persistence data
df <- data.frame(dimension = c(0, 0, 1, 1, 1, 2),
                 birth = rnorm(6),
                 death = rnorm(6, mean = 15))

# create `PHom` instance and print
df_phom <- PHom(df)
df_phom

# print feature details to confirm accuracy
print.data.frame(df_phom)

rrrlw/ripserr documentation built on July 12, 2022, 11:13 a.m.