com.numericalmethod.suanshu.stats.regression.linear.panel

Class PanelData

java.lang.Object

com.numericalmethod.suanshu.stats.regression.linear.panel.PanelData

public class PanelData
extends Object

A panel data refers to multi-dimensional data frequently involving measurements over time. Panel data contain observations of multiple phenomena obtained over multiple time periods for the same firms or individuals. In biostatistics, the term longitudinal data is often used instead, wherein a subject or cluster constitutes a panel member or individual in a longitudinal study.

See Also:

Wikipedia: Panel data

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PanelData.Row This is one row of the data in a panel.
static interface	PanelData.Transformation Transforms the data, e.g., taking log.

Constructor Summary

Constructors

Constructor and Description
PanelData(String subjectHeader, String timeHeader, String[] headers) Constructs a panel of two-dimensional data.

Method Summary

Modifier and Type	Method and Description
void	addRow(PanelData.Row row) Inserts a row of data into the panel.
void	addRow(String subject, String time, double... values) Inserts a row of data into the panel.
String[]	getExtHeaders() Gets the extended headers, including the subject and time headers.
String	getExtHeadersString() Gets the extended headers, including the subject and time headers.
static double[][]	getFactorValues(List<PanelData.Row> rows, String[] headers) Gets the factor values from a panel data.
static double[][]	getFactorValues(List<PanelData.Row> rows, String[] headers, PanelData.Transformation[] transformations) Gets the factor values from a panel data.
String[]	getHeaders() Gets the headers, excluding the subject and time headers.
String	getHeadersString() Gets the extended headers, including the subject and time headers.
PanelData.Row	getRow(String subject, String time) Gets one particular row indexed by a pair of subject and time.
List<PanelData.Row>	getRows() Gets all of the panel data.
List<PanelData.Row>	getRowsForSubject(String subject) Get all the rows pertaining to a particular subject.
List<String>	getSubjects() Gets the name of all subjects.
boolean	isBalanced() Checks if the panel is balanced.
int	size() Get the number of rows in the panel.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PanelData

public PanelData(String subjectHeader,
                 String timeHeader,
                 String[] headers)

Constructs a panel of two-dimensional data.

Parameters:

subjectHeader - the name of the subjects

timeHeader - the name of the times

headers - the data/column names

Method Detail

addRow

public void addRow(String subject,
                   String time,
                   double... values)

Inserts a row of data into the panel.

Parameters:

subject - the subject

time - the time

values - the row data

addRow

public void addRow(PanelData.Row row)

Inserts a row of data into the panel.

Parameters:

row - a row

size

public int size()

Get the number of rows in the panel.

Returns:

the number of rows

isBalanced

public boolean isBalanced()

Checks if the panel is balanced.

Returns:

true if the panel is balanced

getExtHeaders

public String[] getExtHeaders()

Gets the extended headers, including the subject and time headers.

Returns:

the array of extended headers

getExtHeadersString

public String getExtHeadersString()

Gets the extended headers, including the subject and time headers.

Returns:

the string of extended headers

getHeaders

public String[] getHeaders()

Gets the headers, excluding the subject and time headers.

Returns:

the array of extended headers

getHeadersString

public String getHeadersString()

Gets the extended headers, including the subject and time headers.

Returns:

the string of extended headers

getRows

public List<PanelData.Row> getRows()

Gets all of the panel data.

Returns:

all rows in the panel

getRowsForSubject

public List<PanelData.Row> getRowsForSubject(String subject)

Get all the rows pertaining to a particular subject.

Parameters:

subject - the subject

Returns:

all the rows pertaining to a particular subject

getRow

public PanelData.Row getRow(String subject,
                            String time)

Gets one particular row indexed by a pair of subject and time.

Parameters:

subject - the subject

time - the time

Returns:

the indexed row

getSubjects

public List<String> getSubjects()

Gets the name of all subjects.

Returns:

all subject names

toString

public String toString()

Overrides:

toString in class Object

getFactorValues

public static double[][] getFactorValues(List<PanelData.Row> rows,
                                         String[] headers,
                                         PanelData.Transformation[] transformations)

Gets the factor values from a panel data. Note: each row corresponds to a factor/header value (a transpose of the panel data)

Parameters:

rows - the panel data.

headers - the factors to be extracted

transformations - the transformation to be applied to the factor values

Returns:

the factor values

getFactorValues

public static double[][] getFactorValues(List<PanelData.Row> rows,
                                         String[] headers)

Gets the factor values from a panel data. Note: each row corresponds to a factor/header value (a transpose of the panel data)

Parameters:

rows - the panel data.

headers - the factors to be extracted

Returns:

the factor values