get.format: Get details of PEcAn Model from the database using model id

In PecanProject/rpecanapi: R Library that interacts with the PEcAn API

Get details of PEcAn Model from the database using model id

Description

Get details of PEcAn Format from the database using format id. Hits the ⁠/api/formats/{format_id}⁠ API endpoint.

Usage

get.format(server, format_id)

Arguments

server	Server object obtained using the connect() function
format_id	ID of the model to retrieve

Value

Response obtained from the ⁠/api/formats/{format_id}⁠ endpoint

Author(s)

Tezan Sahu

Examples

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

# Get details of the Ameriflux.level4.h format (id = 19)
res <- get.format(server, format_id=19)

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