GetMappingStats: Gets various statistics related to the mapping between two...

View source: R/GetMappingStats.R

GetMappingStatsR Documentation

Gets various statistics related to the mapping between two paths.

Description

Returns a list object containing statistics related to the mapping between a pair of paths..

Usage

 GetMappingStats(mapping)

Arguments

mapping

The output of GetMinMapping()

Details

This provides a detailed analysis of the outcome of a mapping, in the form of several statistics that can be used for further analysis.

Value

length1

The length of path 1

length2

The length of path 2

overlap

The percent overlap between paths. That is, the percent of both paths that map onto a point on the other path, other than the end point. If two paths match for half of the longer path but one path is shortened, this should measure the proportion of the shortening.

deviation

The Area-based deviation between paths

devperunit

Deviation divided by the geometric mean of the lengths of path 1 and path 2

percentdev

Percent deviation–sqrt of deviation divided by geometric length of path1 and path2. This measures the proportion of the length that of the average deviation.

adjusteddev

percentdev divided by overlap–proportion overlap is lengthened by amount of overlap. If overlap is 1.0, no adjustment.

Author(s)

Shane T. Mueller


stmueller/pathmapping documentation built on Nov. 13, 2023, 12:39 p.m.