screen_vms_file: Screen a VMS file and submit for QC checks

In ices-tools-prod/icesVMS: Link to the ICES Vessel Monitoring System and Logbook Database Web Services

Screen a VMS file and submit for QC checks

Description

In this web service the user can upload a file to be screen and validated by the VMS database. The service can be called using post and the file will have to be part of the body of the call. The user needs to be authenticated in order to call this service. This file can be later pushed to the database by the same user.

Usage

screen_vms_file(filename, verbose = FALSE, force = FALSE)

Arguments

filename	file name of the file containing the data to screen
verbose	return verbose information about the POST request
force	force submission even if checks to do not pass

Value

text message from the screening process

Examples

## Not run: 
# requires authorization
filename <- system.file("test_files/vms_test.csv", package = "icesVMS")
screen_vms_file(filename)

filename <- system.file("test_files/vms_test_ok.csv", package = "icesVMS")
screen_vms_file(filename)

## End(Not run)

ices-tools-prod/icesVMS documentation built on April 24, 2023, 2:31 a.m.