available: Providing values from the indicated column that occur at...

In PriceIndices: Calculating Bilateral and Multilateral Price Indexes

Providing values from the indicated column that occur at least once in one of the compared periods or in a given time interval

Description

The function returns all values from the indicated column (defined by the type parameter) which occur at least once in one of the compared periods or in a given time interval.

Usage

available(data, period1, period2, type = "prodID", interval = FALSE)

Arguments

data	The user's data frame. It must contain a column time (as Date in format: year-month-day,e.g. '2020-12-01') and also a column indicated by the type parameter.
period1	The first period (as character) limited to the year and month, e.g. "2019-03".
period2	The second period (as character) limited to the year and month, e.g. "2019-04".
type	This parameters defines the column which is used in the procedure. Possible values of the type parameter are: retID, prodID, codeIN, codeOUT or description.
interval	A logical parameter indicating whether the procedure is to work for the whole time period between period1 and period2 (then it is TRUE).

Value

The function returns all values from the indicated column (defined by the type parameter) which occur at least once in one of the compared periods or in a given time interval. Possible values of the type parameter are: retID, prodID, codeIN, codeOUT or description. If the interval parameter is set to FALSE, then the function compares only periods defined by period1 and period2. Otherwise the whole time period between period1 and period2 is considered.

Examples

available(milk, period1="2018-12", period2="2019-12", interval=TRUE)
available(milk, period1="2018-12", period2="2019-12", type="description")

PriceIndices documentation built on Sept. 11, 2024, 8:35 p.m.