similarityScore {LymphoSeq} | R Documentation

## Similarity score

### Description

Calculates the similarity score of two samples.

### Usage

    similarityScore(sample1, sample2)

### Arguments

`sample1` | A data frame consisting of frequencies of antigen receptor sequences. "aminoAcid" and "count" are a required columns.
`sample2` | A data frame consisting of frequencies of antigen receptor sequences. "aminoAcid" and "count" are a required columns.

### Value

Returns the similarity score, a measure of the amount of overlap between two samples. The value ranges from 0 to 1 where 1 indicates the sequence frequencies are identical in the two samples and 0 indicates no shared frequencies.

### See Also

`similarityMatrix`

### Examples

    file.path <- system.file("extdata", "TCRB_sequencing", package = "LymphoSeq")

    file.list <- readImmunoSeq(path = file.path)

    productive.aa <- productiveSeq(file.list, aggregate = "aminoAcid")

    similarityScore(productive.aa[["TRB_Unsorted_32"]], productive.aa[["TRB_Unsorted_83"]])

[Package LymphoSeq version 1.15.0 Index]