Man pages for PecanProject/rpecanapi
R Library that interacts with the PEcAn API

connectCreates a server object that can be passed into other...
download.inputDownload & save the desired input file
download.run.inputDownload & save the desired input file for a run
download.run.outputDownload & save the desired output file for a run
download.workflow.fileDownload & save the desired file for a workflow
get.formatGet details of PEcAn Model from the database using model id
get.modelGet details of PEcAn Model from the database using model id
get.model.idGet the model ID from the exact name & revision
get.pftGet details of PEcAn PFT from the database using PFT id
get.runGet the details of a particular PEcAn run using the run ID
get.runsGet list of PEcAn Runs that belong to a specific workflow
get.siteGet details of PEcAn Site from the database using site id
get.statusGets general information about PEcAn & the details of the...
get.workflowGet the details of a particular PEcAn workflow using the...
get.workflowsGet list of PEcAn Workflows from the database
get.workflow.statusGet the status of a particular PEcAn workflow using the...
get.workflow.time.elapsedGet the time taken for a workflow to reach its current state...
pingPings the PEcAn API server to see if it is live
plot_run_varsPlot the desired variables from the results of a PEcAn run
search.formatsSearch for PEcAn Models from the database
search.inputsSearch for PEcAn Models from the database
search.modelsSearch for PEcAn Models from the database
search.pftsSearch for PEcAn PFTs from the database
search.sitesSearch for PEcAn Sites from the database
submit.workflowSubmit a PEcAn workflow using various user-defined parameters...
submit.workflow.jsonSubmit a JSON file as a PEcAn workflow & obtain the...
submit.workflows.csvSubmit a bunch of PEcAn workflows, the details of which are...
submit.workflow.xmlSubmit an XML file as a PEcAn workflow & obtain the...
PecanProject/rpecanapi documentation built on April 2, 2024, 8:17 a.m.