dfidx (version 0.1-0)

idx_name: Get the names of the indexes

Description

This function extract the names of the indexes or the name of a specific index

Usage

idx_name(x, n = 1, m = NULL)
# S3 method for dfidx
idx_name(x, n = NULL, m = NULL)
# S3 method for idx
idx_name(x, n = NULL, m = NULL)
# S3 method for xseries
idx_name(x, n = NULL, m = NULL)

Value

if n is NULL, a named integer which gives the posititon of the idx column in the dfidx object, otherwise, a character of length 1

Arguments

x

a dfidx, a idx or a xseries object

n

the index to be extracted (1 or 2, ignoring the nesting variables)

m

if > 1, a nesting variable

Author

Yves Croissant

Examples

mn <- dfidx(munnell, idx = c(region = "state", president = "year"))
# get the position of the idx column
idx_name(mn)
# get the name of the first index
idx_name(mn, 1)
# get the name of the second index
idx_name(mn, 2)
# get the name of the nesting variable for the second index
idx_name(mn, 2, 2)