similar: Abstract parent class for similarity comparison
View source: R/0-parent-children.R
| similar | R Documentation |
Abstract parent class for similarity comparison
Description
similar is an S3 class for all similarity comparison objects.
This class defines common properties shared among child classes
like similar_text, similar_factor, and similar_number.
Usage
similar(scores, summary, methods, list_names, digits = 3)
Arguments
scores |
List of similarity scores per method and comparison |
summary |
Summary statistics by method and comparison |
methods |
Character vector of methods used for comparison |
list_names |
Character vector of names for the compared lists |
digits |
Number of digits to round results (default: 3) |
Details
This class provides the foundation for all similarity comparison classes. It includes common properties:
scores: List of similarity scores per method and comparison
summary: Summary statistics by method and comparison
methods: Character vector of methods used for comparison
list_names: Character vector of names for the compared lists
digits: Number of digits to round results in output
Value
An object of class "similar" with the following components:
scores: List of similarity scores per method and comparison
summary: Summary statistics by method and comparison
methods: Character vector of methods used for comparison
list_names: Character vector of names for the compared lists
digits: Number of digits to round results in output
The similarity scores are normalized values between 0 and 1, where 1 indicates perfect similarity and 0 indicates no similarity.
