epGet: Get enviPath objects

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

Get enviPath objects

Description

epGet returns raw objects from enviPath.

Usage

epGet(
  type,
  init = NULL,
  pkg = NULL,
  property = NULL,
  BPPARAM = bpparam(),
  rate = 5
)

Arguments

type	Character scalar. String specifying the object type to be fetched.
init	Character vector. Vector of strings specifying the initial values of type that should be fetched. When null, all objects belonging to type in pkg are used. (Default: NULL)
pkg	Character scalar. String specifying the unique identifier of the package from which objects should be fetched. When null, EAWAG-BBD is used. (Default: NULL)
property	Character scalar. String specifying the property to be fetched from the objects. When null, all elements of the objects are returned. (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 list of objects

Examples

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

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

# Get custom reaction object
epGet("reaction", rxn_id)
}

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