get_pdb_api_url: Generate a PDB API URL

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

Generate a PDB API URL

Description

This function constructs a full PDB API URL by concatenating the base URL, an API endpoint, and an identifier.

Usage

get_pdb_api_url(endpoint, id, base_url = BASE_URL)

Arguments

endpoint	A character string representing the specific API endpoint to be accessed (e.g., "/pdb/entry/").
id	A character string representing the identifier for the resource (e.g., a PDB ID or other relevant ID).
base_url	A string representing the base URL to generate PDB API url. By default, this is set to the global constant BASE_URL, but users can specify a different URL if needed.

Value

A character string containing the full URL for accessing the PDB API resource.

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