ccrepeSampleTestFunction: ccrepeSampleTestFunction - Simple example of a test measurent...

ccrepeSampleTestFunctionR Documentation

ccrepeSampleTestFunction - Simple example of a test measurent function to be used with ccrepe

Description

This simple example of a test measurent function to be used with ccrepe
used in the same fashion that cor would be used
Some properties of the function:
1. Be able to take either two inputs which are vectors or one input which
is either a matrix or a data frame
3.In the case of one input, return a matrix in which the (i,j)th entry
is the similarity score for column i and column j in the original matrix
4.Resulting matrix must be symmetric
5.The inputs must be named x and y

Usage

ccrepeSampleTestFunction(x, y = NA)

Arguments

x

x is a vector or a matrix

y

y is a vector.
if y selected then x must be a vector too

Value

If x and y are vectors it returns a number: 0.5 If x is a matrix it returns a matrix of all 0.5

Author(s)

Emma Schwager <emma.schwager@gmail.com>


biobakery/ccrepe documentation built on March 30, 2024, 1:50 a.m.