productionProcessingParameters: Default Processing Parameters

In SWS-Methodology/faoswsProduction: Package to perform the imputation of area harvested, production and yield for the FAO production domain

Default Processing Parameters

Description

This function can be used to generate the input parameters for the data pre-processing code. This is a good way to get a list of the required parameters and then modify parameters to match your particular configuration.

Usage

productionProcessingParameters(datasetConfig, dataset = "aproduction",
  removePriorImputation = FALSE, removeManualEstimation = FALSE,
  keepOnlyProtected = TRUE, imputationObservationFlag = "I",
  imputationMethodFlag = "e", balanceMethodFlag = "i",
  manualEstimationObservationFlag = "E", manualEstimationMethodFlag = "f",
  missingValueObservationFlag = "M", missingValueMethodFlag = "u")

Arguments

datasetConfig	The dataset configuration returned by the function GetDatasetConfig
dataset	The dataset name in the database.
removePriorImputation	logical, whether previous imputation values should be removed.
removeManualEstimation	logical, whether previous manual estimation should be removed.
imputationObservationFlag	The observation flag that represents imputation.
imputationMethodFlag	The observation flag that represents estimated by statistical algorithm.
balanceMethodFlag	The method flag that for calculation based on identity
manualEstimationObservationFlag	The observation status flag that corresponds to manual (FAO) estimates
manualEstimationMethodFlag	The method flag that corresponds to manual (FAO) estimates
missingValueObservationFlag	The observation flag corresponding to missing values.
missingValueMethodFlag	The method flag corresponding to missing values.

Details

Below is a description of the parameters:

• areaVar: The column corresponding to the geographic area.

• yearVar: The column corresponding to the time dimension.

• itemVar: The column corresponding to the item/commodity.

• elementVar: The column corresponding to the measured element.

• valueVar: The name for value column in the normalised form.

• flagObservationVar: The name for observation flag in the normalised form.

• flagMethod: The name for method flag in the normalised form.

• removePriorImputation: Should previous imputations be removed?

• removeManualEstimation: Should previous manual estimates be removed?

• imputationObservationFlag: The flag for imputation.

• imputationMethodFlag: The observation flag that represents estimated by statistical algorithm.

• balanceMethodFlag: The method flag that for calculation based on identity

• manualEstimationObservationFlag: The observation status flag that corresponds to manual (FAO) estimates

• manualEstimationMethodFlag: The method flag that corresponds to manual (FAO) estimates

• missingValueObservationFlag: The observation flag corresponding to missing values.

• missingValueMethodFlag: The method flag corresponding to missing values.

Value

Returns a list of the default parameters used in the data pre-processing algorithm.

SWS-Methodology/faoswsProduction documentation built on March 21, 2023, 8:27 p.m.