get.run: Get the details of a particular PEcAn run using the run ID

View source: R/get.run.R

get.runR Documentation

Get the details of a particular PEcAn run using the run ID

Description

Obtain the details of a details of a specified PEcAn run. Hits the ⁠/api/run/{id}⁠ API endpoint

Usage

get.run(server, run_id)

Arguments

server

Server object obtained using the connect() function

run_id

ID of the PEcAn run whose details are needed

Value

Response obtained from the ⁠/api/run/{id}⁠ endpoint

Author(s)

Tezan Sahu

Examples

server <- connect(url="http://pecan.localhost:80", username="carya", password="illinois")

# Get details of run with id = '1002042201'
res <- get.run(server, 1002042201)

PecanProject/rpecanapi documentation built on April 2, 2024, 8:17 a.m.