getAupusDataset: Get AUPUS Data

In SWS-Methodology/faoswsAupus: Package to perform the AUPUS calculation.

Description

This function obtains all required data for the AUPUS module by running several individual functions, such as getRatioData, getShareData, etc. The datasets returned by these individual functions are then returned from this function in a list (if assignGlobal = FALSE) or are assigned to the global environment (if assignGlobal = TRUE).

Usage

getAupusDataset(aupusParam, assignGlobal = FALSE)

Arguments

aupusParam	A list of running parameters to be used in pulling the data. Typically, this is generated from getAupusParameter (see that function for a description of the required elements).
assignGlobal	Whether the data should be assigned globally (TRUE) or returned as a list (FALSE). Defaults to FALSE.

Value

If assignGlobal = FALSE, then a list is returned with names "aupusData", "inputData", "ratioData", "shareData", "balanceElementData", "itemInfoData", "populationData", and "extractionRateData". Each of these elements is a data.table containing information for the AUPUS processing. If assignGlobal = TRUE, then these data.tables are assigned to the global environment and no data is returned.

SWS-Methodology/faoswsAupus documentation built on May 9, 2019, 11:45 a.m.