Learn R Programming

rPDBapi (version 2.1.1)

ScoredResult: Create a Scored Result Object for PDB Searches

Description

The `ScoredResult` function constructs a scored result object, typically used in search results to associate an entity ID with a numerical score. This is useful in ranking search results or displaying relevance scores alongside the results.

Usage

ScoredResult(entity_id, score)

Value

A list representing the scored result, which can be included in the search results or used for further processing.

Arguments

entity_id

A string representing the entity ID. This could be a PDB ID or any identifier relevant to the search.

score

A numeric value representing the score associated with the entity. The score often indicates the relevance or quality of the match.

Examples

Run this code
# \donttest{
result <- ScoredResult(entity_id = "1XYZ", score = 95.6)
# }

Run the code above in your browser using DataLab