removeManualEstimation: Function to remove estimations manually derived. It refers to...

Description Usage Arguments Details Value

View source: R/removeManualEstimation.R

Description

Function to remove estimations manually derived. It refers to values characerised by FlagObservationStatus = E and FlagMethodPass= "f"

Usage

1
2
3
removeManualEstimation(data, valueVar, observationFlagVar, methodFlagVar,
  missingObservationFlag = "M", missingMethodFlag = "u",
  estimationObservationFlag = "E", manuallyEstimationMethodFlag = "f")

Arguments

data

The data.table object containing the values.

valueVar

The column name of data which contains the values for the variable to be modified.

observationFlagVar

The column name of the observation flag corresponding to value.

methodFlagVar

The column name of the method flag corresponding to value.

missingObservationFlag

The character value which is used to represent missing values in the observation flag. This value will be put in any column containing imputation data that is removed.

missingMethodFlag

The character value which is used to represent missing values in the method flag. This value will be put in any column containing imputation data that is removed.

estimationObservationFlag

This character value specifies which observation flags correspond to imputed/estimated values in the data.

manuallyEstimationMethodFlag

This character value specifies which method flags correspond to imputed/estimated values in the data.

Details

Observations which have observationFlagVar == imputedFlag will be modified to missing. Thus, the value will be updated to NA, the observation flag will be updated to missingObservationFlag, and the method flag will be updated to missingMethodFlag.

Value

No value is returned. However, the object "data" which was passed to this function is modified.


SWS-Methodology/faoswsSeed documentation built on Sept. 6, 2018, 5:06 a.m.