Check if an object is a pseries

Source: R/tool_pdata.frame.R

This function checks if an object qualifies as a pseries

is.pseries(object)

Arguments

object

object to be checked for pseries features

Value

A logical indicating whether the object is a pseries (TRUE) or not (FALSE).

Details

A "pseries" is a wrapper around a "basic class" (numeric, factor, logical, character, or complex).

To qualify as a pseries, an object needs to have the following features:

  • class contains "pseries" and there are at least two classes ("pseries" and the basic class),

  • have an appropriate index attribute (defines the panel structure),

  • any of is.numeric, is.factor, is.logical, is.character, is.complex is TRUE.

See also

pseries() for some computations on pseries and some further links.

Examples


# Create a pdata.frame and extract a series, which becomes a pseries
data("EmplUK", package = "plm")
Em <- pdata.frame(EmplUK)
z <- Em$output

class(z) # pseries as indicated by class
#> [1] "pseries" "numeric"
is.pseries(z) # and confirmed by check
#> [1] TRUE

# destroy index of pseries and re-check
attr(z, "index") <- NA
is.pseries(z) # now FALSE
#> [1] FALSE