download.run.output: Download & save the desired output file for a run

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

Download & save the desired output file for a run

Description

Downloads & saves the desired output file for a run. Hits the ⁠/api/run/{run_id}/output/{filename}⁠ API endpoint

Usage

download.run.output(server, run_id, filename, save_as = NULL)

Arguments

server	Server object obtained using the connect() function
run_id	ID of the PEcAn run whose output is needed
filename	Name of the output file to be downloaded
save_as	File name to save the downloaded file as. Default: NULL (same name as filename would be used)

Value

Response obtained from the ⁠/api/run/{run_id}/output/{filename}⁠ endpoint

Author(s)

Tezan Sahu

Examples

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

# Download the 'README.txt' output for the run with id = '99000000282'
download.run.output(server, run_id=99000000282, filename='README.txt', save_as='test.README.txt')

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