Parameters: Life history parameters from data

In Biograph: Explore Life Histories

Description

Extracts state space and other characteristics from Biograph object

Usage

Parameters(Bdata,newnamstates)

Arguments

Bdata	Biograph object
newnamstates	Biograph detect determines the state space from the data set. The sequence of states detected may not be the most logical sequence. newnamstates allows to change the sequence. Default: sequence of labels detected by Biograph.

Details

Parameters extracts useful information and stores it in values returned by the function.

1. nsample: sample size

2. numstates: number of states in the state space (produced by StateSpace)

3. namstates: labels for the states (determined from the character variable <path>) (produced by StateSpace)

4. absorbstates: vector of absorbing states (determined by StateSpace)

6. iagelow: lowest age in the (sample) population (determined from date at entry in observation and date of birth)

7. iagehigh: highest age in the (sample) population (determined from date at exit from observation and date of birth)

8. namage: labels for the single years of age from the lowest age (iagelow) to the highest age (iagehigh)

9. nage: number of age groups: iagehigh - iagelow + 1

10. maxtrans: maximum number of transitions

11. ntrans: number of transitions

12. trans_possible: transition matrix: feasible transitions

12. tmat: matrix with transition numbers

13. transitions: identifications of transitions: number, origin, destination

14. nntrans: transition counts by origin and destination

15. locpat: column number of <path> variable in Biograph object

16. ncovariates: number of covariates

17. covariates: vector of covariate names

18. format.date: format of date variables (chronological objects) in Biograph object

19. format.born: format of date of birth

The parameters and the format of the dates (format.date) are attached to the Biograph object (Bdata) as attributes.

Value

sample	Sample size
numstates	number of states in state space
namstates	names of states
absorbstates	names of absorbing states
iagelow	lowest age
iagehigh	highest age
namage	names of age groups
nage	number of age groups
maxtrans	maximum number of transitions by individual
ntrans	number of transitions
trans_possible	Origin-destination matrix of logical elements indicating whether transition is allowed or not. In multistate survival analysis, the matrix is known as 'transition matrix'
tmat	Origin-destination matrix showing the line numbers of the transitions. A number is allocated to each possible transition. The matrix tmat is attached as an attribute to the data file.
transitions	Data frame which gives for each transition the following information: origin and destination in character value and numeric value
nntrans	Number of transitions by origin and destination
ncovariates	number of covariates
covariates	covariate labels
format.date	format of date variables in Biograph object
format.born	format of date of birth in Biograph object

Author(s)

Frans Willekens

See Also

StateSpace

Examples

# Example 1
  data(GLHS)
  z <- Parameters(GLHS)
# Example 2
  data (NLOG98)
  z <- Parameters(NLOG98,newnamstates=c("H","A","C","M","K"))
  

Biograph documentation built on May 1, 2019, 8:48 p.m.