removeBrokenVesselLinks: Remove rows which are not pointing to a valid VesselDetails...

View source: R/removeBrokenVesselLinks.R

removeBrokenVesselLinksR Documentation

Description

Remove rows which are not pointing to a valid VesselDetails (VD) records i.e. those rows which have a value of VDid that does not exist in the VD table.

Usage

removeBrokenVesselLinks(objectToCheck, verbose = FALSE, strict = TRUE)

Arguments

objectToCheck

an RDBESDataObject.

verbose

(Optional) If set to TRUE more detailed text will be printed out by the function. Default is TRUE.

strict

(Optional) This function validates its input data - should the validation be strict? The default is TRUE.

Value

an RDBESDataObject with any records with an invalid VDid removed

Examples

## Not run: 

myH1RawObject <-
  importRDBESDataCSV(rdbesExtractPath = "tests\\testthat\\h1_v_1_19")
myFields <- c("VDlenCat")
myValues <- c("18-<24")
myFilteredObject <- filterRDBESDataObject(myH1RawObject,
  fieldsToFilter = myFields,
  valuesToFilter = myValues
)
myObjectValidVesselLinks <- removeBrokenVesselLinks(
  objectToCheck = myFilteredObject,
  verbose = FALSE
)

## End(Not run)

ices-tools-dev/icesRDBES documentation built on April 17, 2025, 1:58 p.m.