get_grts_covariate: Get Covariate data for all GRTS in a Sample Frame

View source: R/nabat_gql_queries.R

get_grts_covariateR Documentation

Get Covariate data for all GRTS in a Sample Frame

Description

Using a covariate and sample frame id, return a dataframe of each grts and the information coresponding to that covariate.

Usage

get_grts_covariate(
  token,
  covariate_id,
  sample_frame_id,
  branch = "prod",
  url = NULL,
  aws_gql = NULL,
  aws_alb = NULL,
  docker = FALSE
)

Arguments

token

List token created from get_nabat_gql_token() or get_refresh_token()

covariate_id

Numeric Id for the covariate to query. This value can be extrapolated from the output of get_covariates()

sample_frame_id

Numeric Id for the sample frame to query. This value can be extrapolated from the output of get_sample_frames()

branch

(optional) String that defaults to 'prod' but can also be 'dev'|'beta'|'local'

url

(optional) String url to use for GQL

aws_gql

(optional) String url to use in aws

aws_alb

(optional) String url to use in aws

docker

(optional) Boolean if being run in docker container or not


usgs/nabatr documentation built on Jan. 28, 2024, 7:10 a.m.