connect: Creates a server object that can be passed into other...

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

Creates a server object that can be passed into other functions for making requests to the PEcAn API

Description

Creates a server object containing the base URL of the PEcAn API server, the username & password, which can be simply passed into other functions to make requests to the PEcAn API. Currently, there is no validation. In future, we may validate the username-password pair by hitting the appropriate API endpoint

Usage

connect(url, username = NULL, password = NULL)

Arguments

url	Base URL of the PEcAn API Server
username	Username
password	Password corresponding to the username

Value

A server object that can be passed into other functions for making requests to the PEcAn API

Examples

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

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