uploadDatsuFileFireAndForget: get list of records for a dataset

In icesDatsu: Functions to Interact with the ICES Data Submission Utility (DATSU)

get list of records for a dataset

Description

This API allows the user to screen a file using the API.

Usage

uploadDatsuFileFireAndForget(
  fileToUpload,
  dataSetVerID,
  emailAddress = NULL,
  sendEmail = TRUE,
  errorLimit = 30000,
  verbose = FALSE
)

Arguments

fileToUpload	the filename of the file to upload
dataSetVerID	The version of the dataset
emailAddress	alternative email address of the user, if NULL, email address from ICES token is used
sendEmail	it is set to TRUE by default, this will specify if the user will to receive an email when the session is finished
errorLimit	does not need to be specified, it is 30000 by default
verbose	get verbose output from the POST request, default FALSE

Value

The ID of the DATSU session

Examples

## Not run: 
filename <- system.file("test_files/vms_test.csv", package = "icesDatsu")
id <- uploadDatsuFileFireAndForget(filename, 145)
getScreeningSessionDetails(id)
messages <- getScreeningSessionMessages(id)
head(messages)

uploadDatsuFileFireAndForget(filename, 145, sendEmail = FALSE)

## End(Not run)

icesDatsu documentation built on Oct. 25, 2024, 1:06 a.m.