contained: Method to check if a filament is completely contained in a...

Description Usage Arguments Value

View source: R/containment-and-band-creation.R

Description

Completely contained should be thought of as "uniform" containment.

Usage

1
2
3
4
5
6
7
contained(x, y, .lower_simplex_project = TRUE)

## S3 method for class 'delta_ball_structure'
contained(x, y, .lower_simplex_project = TRUE)

## S3 method for class 'convex_hull_structure'
contained(x, y, .lower_simplex_project = TRUE)

Arguments

x

assumed to either convex_hull_structure or delta_ball_structure objects

y

data.frame with filament represented in it

.lower_simplex_project

boolean, if y should be projected to a simplex and then to the lower dimensional simplex (that x probably was). For this package, this should always be done.

Value

boolean if y is contained in x


skgallagher/EpiCompare documentation built on Sept. 14, 2021, 5:45 a.m.