eoR (version 0.4.0)

EX1-class: EX1 class for HMD eposure files 1x1

Description

The class EX1 stores HMD exposure information in a systematic way.

The header-method gets the raw header information of an EX1 object

The ex1-method gets the exposure information of an EX1 object

The content-method gets the exposure table information of an EX1 object

The region-method gets the regional information of an EX1 object

The protocol-method gets the protocol information of an EX1 object

The Exposure1-constructor creates an EX1 object

The length-method gets the number of rows int the EX1 ex1 data.table

The selectYears-method gets a subset of an EX1 object

The readEX1x1-method reads all information from the file 1x1 exposure table

Usage

# S4 method for EX1
header(object)
# S4 method for EX1
ex1(object)
# S4 method for EX1
content(object)
# S4 method for EX1
region(object)
# S4 method for EX1
protocol(object)
Exposure1(header, ex1, content, region, protocol)
# S4 method for EX1
length(x)
# S4 method for EX1
show(object)
# S4 method for EX1
selectYears(object, selectYears)
readEX1x1(infile)

Arguments

object

EX1-object

header

vector

ex1

data.table

content

character

region

character

protocol

character

x

EX1-object

selectYears

vector

infile

character file name

Value

The header-method returns the raw header information

The ex1-method returns the exposure table

The content-method returns the content information

The region-method returns the regional information

The protocol-method returns the protocol information

The Exposure1-constructor returns an EX1 object

The length-method returns the number of rows

The selectYears-method returns an EX1 object

The readEX1x1-method returns an EX1 object

Slots

content

describes the content

region

regional entity

header

includes the raw header information

ex1

stores the exposure table (data.table)

protocol

contains the protocol information

Details

This EX1 class fits to Human Mortality Database (HMD) 1x1 period exposure tables. See https://www.mortality.org/ for data details. An EX1 instance stores the raw header, the content, the version protocol and regional information and the exposure table as a data.table object. The validation adds a pure numeric age AgeLow to the exposure table. Try demo(EX1) for a demonstration.

Examples

# NOT RUN {
e1 <- readEX1x1(file.path(system.file(package="eoR"), "extdata", "DEUTNP.Exposures_1x1m.txt"))
header(e1)
ex1(e1)[, table(Year)]
# }