removeNoInfo: This function removes data with no information

Description Usage Arguments Value

Description

The information contained within a set of index is calculated based on whether a non-zero value exist. If the data contains only zero and missing value then it is considered to contain no information for imputation.

Usage

1
2
removeNoInfo(data, value, observationFlag, byKey,
  environment = parent.frame(1))

Arguments

data

A data.table object containing the data of interest.

value

The column name of the value of the variable.

observationFlag

The column name of the observation flag corresponding to value.

byKey

The column name of the grouping variable. If no data exists for an entire group, then that data is removed from the data.table.

environment

The functions in this package generally work by passing the data.table by reference and modifying it in place. In place row deletion is currently not supported by data.table, see https://github.com/Rdatatable/data.table/issues/635. However, upon resolution of this issue, this function should be updated. However, until then, to make this function consistent with the other functions in this package, environment is passed to specify where the modified data.table should be assigned. The default of parent.frame(1) gives the calling environment and this should be satisfactory for most, if not all, use cases.

Value

No value is returned. However, the object "data" which was passed to this function is modified. In fact, it's actually overwritten if environment = parent.frame(1), the default.


SWS-Methodology/faoswsProcessing documentation built on June 19, 2019, 5:14 p.m.