ScoredResult: Create a Scored Result Object for PDB Searches

In rPDBapi: A Comprehensive Interface for Accessing the Protein Data Bank

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)

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.

Value

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

Examples

result <- ScoredResult(entity_id = "1XYZ", score = 95.6)

rPDBapi documentation built on Sept. 11, 2024, 6:37 p.m.