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

Description Usage Format

This object is an example of the type of object created by the getAupusParameter function. It contains codes/dimensions of the data as well as column name descriptions.

1	data(usAupusParam)

A list object with 5 elements: areaCode, itemCode, elementCode, year, and keyNames. The first four elements are numeric vectors providing the dimensions of the data to be queried (country, commodity, variable, and year, respectively). The last element is another list containing various parameters:

areaName Column name corresponding to the variable containing the location codes.
itemName Column name corresponding to the variable containing the item codes.
itemParentName Used in an edge dataset (i.e. shares), this column name corresponds to the variable containing the parent item code.
itemChildName Used in an edge dataset (i.e. shares), this column name corresponds to the variable containing the child item code.
itemTypeName Column name corresponding to the variable containing the item type, see ?faoswsAupus::itemTypeDescription.
elementName Column name corresponding to the variable containing the element codes.
extractionRateName Column name corresponding to the variable containing extraction rates, see getExtractionRateData.
balanceElementName Column name corresponding to the variable containing the balancing element, see getBalanceElementData.
inputName Column name corresponding to the variable containing the input from processing data, see getInputFromProcessData.
shareName Column name corresponding to the variable containing the share data, see getShareData.
yearName Column name corresponding to the variable containing the year.
valuePrefix To construct variables corresponding to certain elements, the valuePrefix is combined with the itemName element and the element code of interest. For example, paste0(aupusParam$keyName$valuePrefix, aupusParam$keyName$itemName, "_", 11) gives the variable corresponding to element 11.
flagPrefix See above description for valuePrefix, the same applies for the flag variables.
ratioPrefix See above description for valuePrefix, the same applies for the ratio variables.