epLink: Link enviPath objects

In enviPathR: Client for the 'enviPath' 'RESTful' API

Link enviPath objects

Description

epLink returns mappings between enviPath object types.

Usage

epLink(from, to, init = NULL, pkg = NULL, BPPARAM = bpparam(), rate = 5)

Arguments

from	Character scalar. String specifying the object type from which mapping is performed.
to	Character scalar. String specifying the object type to which mapping is performed.
init	Character vector. Vector of strings specifying the initial values of from that should be mapped to to. When null, all objects belonging to from in pkg are used. (Default: NULL)
pkg	Character scalar. String specifying the unique identifier of the package from which objects should be mapped When null, EAWAG-BBD is used. (Default: NULL)
BPPARAM	A BiocParallelParam object specifying how the requests should be parallelised. (Default: bpparam())
rate	Numeric scalar. Integer number specifying the amount of requests per second to be sent to the enviPath API when BPPARAM is not serial. (Default: 5)

Value

A data frame with links between from and to.

Examples

if( is_active ){
# Perform login with your credentials
epLogin(username, password)

# Define custom reaction identifier
rxn_id <- "2b6bbcc5-77f4-4bed-92a9-731cdc978f6a"

# Link custom reaction to related compounds
epLink("reaction", "compound", rxn_id)
}

enviPathR documentation built on Oct. 14, 2026, 5:07 p.m.