new_matrix: Create a new matchr_matrix object

View source: R/matchr_matrix.R

new_matrixR Documentation

Create a new matchr_matrix object

Description

Create a new matchr_matrix object

Usage

new_matrix(
  array = list(),
  x_ar = list(),
  y_ar = list(),
  x_sig = list(),
  y_sig = list(),
  x_total = integer(length = 1L),
  y_total = integer(length = 1L),
  x_na = character(),
  y_na = character(),
  formula = character()
)

Arguments

array

A list of Hamming distance matrices.

x_ar

A list of numeric vectors: the highest and lowest aspect ratio in the x vector.

y_ar

A list of numeric vectors: the highest and lowest aspect ratio in the y vector.

x_sig

A list of matchr_signature vectors: the signatures of the files in the x vector.

y_sig

A list of matchr_signature vectors: the signatures of the files in the y vector.

x_total

An integer scalar: the total number of x signatures analyzed.

y_total

An integer scalar: the total number of y signatures analyzed.

x_na

A character vector: the paths of x signatures which are NA.

y_na

A character vector: the paths of y signatures which are NA.

formula

A character string containing the right hand side of a formula: how the nearest and bilinear Hamming distances were combined to determine an overall distance.

Value

An object of class matchr_matrix.


UPGo-McGill/matchr documentation built on July 19, 2023, 1:02 p.m.