geco_api_url: Formatted URL for api endpoints

View source: R/geco_api.R

geco_api_urlR Documentation

Formatted URL for api endpoints

Description

Formatted URL for api endpoints

Usage

geco_api_url(
  ...,
  project = NULL,
  project_version_id = NULL,
  run_id = NULL,
  parameter = NULL,
  type = NULL,
  filters = NULL,
  url_query_parameters = NULL
)

Arguments

...

path elements to the url

project

(str) project name

project_version_id

(str) project version id, if project not provided

run_id

(str) the run_id, if used by the URL path

parameter

(str) the parameter, if used by the URL path

type

(str) the type as either prior or posterior, if used by the URL path

filters

(str) formatted filters, for endpoints that use this in the URL path

url_query_parameters

(named list) other inputs to the query passed as GET params


generable/rgeco documentation built on Oct. 16, 2024, 2:45 a.m.