Package 'delver'

Title: R Interface to DELVE API
Description: R interface to DELVE API.
Authors: Travis Hinkelman
Maintainer: Travis Hinkelman <[email protected]>
License: MIT + file LICENSE
Version: 0.1.0
Built: 2025-03-11 04:30:49 UTC
Source: https://github.com/EnvironmentalScienceAssociates/delver

Help Index


Delete dataset file

Description

Delete a file from within a DELVE project, dataset, and version.

Usage

delete_dataset_file(
  project_id,
  dataset_id,
  version,
  filename,
  user_token = get_user_token(),
  use_qa = FALSE
)

Arguments

project_id

ProjectID (integer)

dataset_id

DatasetID (integer)

version

Version (integer)

filename

Filename

user_token

DELVE user token

use_qa

Boolean flag to use QA version of DELVE


Get dataset file

Description

Get a file from within a DELVE project, dataset, and version.

Usage

get_dataset_file(
  project_id,
  dataset_id,
  version,
  filename,
  user_token = get_user_token(),
  use_qa = FALSE
)

Arguments

project_id

ProjectID (integer)

dataset_id

DatasetID (integer)

version

Version (integer)

filename

Filename

user_token

DELVE user token

use_qa

Boolean flag to use QA version of DELVE


Get dataset files metadata

Description

Get files metadata from within a DELVE project, dataset, and version.

Usage

get_dataset_files(
  project_id,
  dataset_id,
  version,
  user_token = get_user_token(),
  use_qa = FALSE
)

Arguments

project_id

ProjectID (integer)

dataset_id

DatasetID (integer)

version

Version (integer)

user_token

DELVE user token

use_qa

Boolean flag to use QA version of DELVE


Get metadata

Description

Get DELVE metadata for projects, datasets, dataset types, file types, and keywords.

Usage

get_projects(user_token = get_user_token(), use_qa = FALSE)

get_datasets(user_token = get_user_token(), use_qa = FALSE)

get_dataset_types(user_token = get_user_token(), use_qa = FALSE)

get_file_types(user_token = get_user_token(), use_qa = FALSE)

get_keywords(user_token = get_user_token(), use_qa = FALSE)

Arguments

user_token

DELVE user token

use_qa

Boolean flag to use QA version of DELVE


Set or get DELVE API token

Description

Set or get DELVE API token as environmental variable

Usage

set_user_token(user_token = NULL)

get_user_token()

Arguments

user_token

DELVE user token