Analysing Cross-Classified Data about Populations

Documentation for package ‘dembase’ version 0.0.0.119

DESCRIPTION file.

Help Pages

A C D E F G H I L M N O P R S T U V misc

-- A --

accession	Calculate accession from a movements account.
accession-method	Calculate accession from a movements account.
addDimension	Add one or more dimensions to a demographic array.
addDimension-method	Add one or more dimensions to a demographic array.
addIterationsToMetadata	Classes and functions that are exported but that are not part of the API.
addPair	Add a "destination" or "child" dimension to an object.
addPair-method	Add a "destination" or "child" dimension to an object.
ageMax	Get or set minimum and maximum ages.
ageMax-method	Get or set minimum and maximum ages.
ageMax<-	Get or set minimum and maximum ages.
ageMax<--method	Get or set minimum and maximum ages.
ageMin	Get or set minimum and maximum ages.
ageMin-method	Get or set minimum and maximum ages.
ageMin<-	Get or set minimum and maximum ages.
ageMin<--method	Get or set minimum and maximum ages.
ageMinMax	Get or set minimum and maximum ages.
ageTimeStep	Get the age-time step used by a demographic array.
ageTimeStep-method	Get the age-time step used by a demographic array.
ageToAgeGroup	Convert exact ages to age groups
alignPair	Align categories dimensions that come in pairs.
alignPair-method	Align categories dimensions that come in pairs.
aperm-method	Internal methods
as.array-method	Internal methods
as.data.frame	Convert a DemographicArray to a data.frame
as.data.frame-method	Convert a DemographicArray to a data.frame
as.data.frame-method	Coerce concordances to other formats.
as.list-method	Coerce concordances to other formats.
as.matrix-method	Coerce concordances to other formats.
as.matrix-method	Internal methods
attachSubtotals	Attach a set of known subtotals to a Counts object.
attachSubtotals-method	Attach a set of known subtotals to a Counts object.

-- C --

canMakeCompatible	Classes and functions that are exported but that are not part of the API.
canMakeCompatible-method	Classes and functions that are exported but that are not part of the API.
chain	Chain concordances.
checkAge	Classes and functions that are exported but that are not part of the API.
checkAndTidyAlong	Classes and functions that are exported but that are not part of the API.
classificationFrom	Names of classifications used by concordances.
classificationFrom-method	Names of classifications used by concordances.
classificationFrom<-	Names of classifications used by concordances.
classifications	Names of classifications used by concordances.
classifications-method	Names of classifications used by concordances.
classifications<-	Names of classifications used by concordances.
classifications<--method	Names of classifications used by concordances.
classificationTo	Names of classifications used by concordances.
classificationTo-method	Names of classifications used by concordances.
classificationTo<-	Names of classifications used by concordances.
cleanAgeGroup	Clean up age group labels
cleanAgeGroupConc	Clean up age group labels
codes	Extract the codes used by a concordance.
codes-method	Extract the codes used by a concordance.
codesAmbiguous	Test whether codes in a concordance have fixed meanings.
codesAmbiguous-method	Test whether codes in a concordance have fixed meanings.
coerce-data	Coerce to numeric or integer.
coercion	Coerce concordances to other formats.
collapse	Classes and functions that are exported but that are not part of the API.
collapse-method	Classes and functions that are exported but that are not part of the API.
collapseCategories	Collapse multiple categories into a single category.
collapseCategories-method	Collapse multiple categories into a single category.
collapseDimension	Collapse one or more dimensions of a demographic array.
collapseDimension-method	Collapse one or more dimensions of a demographic array.
collapseIntervals	Collapse intervals.
collapseIntervals-method	Collapse intervals.
collapseIterations	Summarize iterations.
collapseIterations-method	Summarize iterations.
collapseOrigDest	Convert data on movements into a less detailed format.
collapseOrigDest-method	Convert data on movements into a less detailed format.
CollapseTransform-class	Classes and functions that are exported but that are not part of the API.
CollapseTransformExtra-class	Classes and functions that are exported but that are not part of the API.
Compare-method	Internal methods
componentNames	Get or set the names of components of a demographic account.
componentNames-method	Get or set the names of components of a demographic account.
componentNames<-	Get or set the names of components of a demographic account.
componentNames<--method	Get or set the names of components of a demographic account.
components	Extract one or more components from a demographic account.
components-method	Extract one or more components from a demographic account.
Concordance	Create a concordance.
Concordance-class	S4 class for holding concordances.
Counts	Create objects of class "Counts" or "Values".
Counts-class	Classes "DemographicArray", "Counts", and "Values".
Counts-method	Create objects of class "Counts" or "Values".
counts-values-generator	Create objects of class "Counts" or "Values".
CountsOne	Create one-dimensional object of class "Counts" or "Values"
countsone-valuesone	Create one-dimensional object of class "Counts" or "Values"
CountsWithSubtotals-class	S4 Class For Counts with Subtotals.
CountsWithSubtotalsInternal-class	Classes and functions that are exported but that are not part of the API.
credibleInterval	Calculate credible intervals
credibleInterval-method	Calculate credible intervals

-- D --

datesToAgeGroups	Calculate ages, periods, cohorts, and Lexis triangles from dates.
datesToCohorts	Calculate ages, periods, cohorts, and Lexis triangles from dates.
datesToPeriods	Calculate ages, periods, cohorts, and Lexis triangles from dates.
datesToTriangles	Calculate ages, periods, cohorts, and Lexis triangles from dates.
dbind	Combine DemographicArray objects.
dembase	Analysing cross-classified data about populations
DemographicAccount-class	Classes "DemographicAccount", "Movements", "Transitions"
DemographicArray-class	Classes "DemographicArray", "Counts", and "Values".
DemographicArrayOrNumeric-class	Classes "DemographicArray", "Counts", and "Values".
derivePopulation	Derive population counts from initial population and components.
diff-method	Internal methods
dim-method	Internal methods
dim<--method	Internal methods
dimnames-method	Internal methods
dimnames<--method	Internal methods
dimscale	Get or set the dimscales of a demographic array
DimScales	Classes and functions that are exported but that are not part of the API.
dimscales	Get or set the dimscales of a demographic array
DimScales-method	Classes and functions that are exported but that are not part of the API.
dimscales-method	Get or set the dimscales of a demographic array
dimscales-method	Internal methods
DimScales<-	Classes and functions that are exported but that are not part of the API.
dimscales<-	Get or set the dimscales of a demographic array
dimscales<--method	Get or set the dimscales of a demographic array
dimscales<--method	Internal methods
dimtype	Get or set the dimtypes of an object.
dimtypes	Get or set the dimtypes of an object.
dimtypes-method	Get or set the dimtypes of an object.
dimtypes-method	Classes and functions that are exported but that are not part of the API.
dimtypes-method	Internal methods
dimtypes<-	Get or set the dimtypes of an object.
dimtypes<--method	Get or set the dimtypes of an object.
dimtypes<--method	Internal methods
dplot	Construct a lattice plot from a demographic array.
dplot-method	Construct a lattice plot from a demographic array.
drop	Drop dimensions of length one.
drop-method	Internal methods
dtabs	Simplified version of 'xtabs' for constructing demographic arrays

-- E --

expandAx	Classes and functions that are exported but that are not part of the API.
expandCategories	Expand a single category into multiple categories.
expandCategories-method	Expand a single category into multiple categories.
expandIntervals	Split wide intervals into narrower ones
expandIntervals-method	Split wide intervals into narrower ones
exported-not-api	Classes and functions that are exported but that are not part of the API.
exposure	Calculate exposure from population counts.
exposure-method	Calculate exposure from population counts.
exposureBirths	Calculate exposure to use for modelling births.
exposureBirths-method	Calculate exposure to use for modelling births.
exposureHMD	Classes and functions that are exported but that are not part of the API.
extend	Classes and functions that are exported but that are not part of the API.
extend-method	Classes and functions that are exported but that are not part of the API.
extrapolate	Add extrapolated values to demographic array.
extrapolate-method	Add extrapolated values to demographic array.

-- F --

fillForward

Use observed values to fill in missing values in vector

-- G --

getIAfter	Classes and functions that are exported but that are not part of the API.
getIBefore	Classes and functions that are exported but that are not part of the API.
getIShared	Classes and functions that are exported but that are not part of the API.
growth	Calculate average growth rates or increments.
growth-method	Calculate average growth rates or increments.

-- H --

hasRegularAgeTime	Age steps and time steps of demographic array.
hasRegularAgeTime-method	Age steps and time steps of demographic array.

-- I --

iFemale	Classes and functions that are exported but that are not part of the API.
iMale	Classes and functions that are exported but that are not part of the API.
impute	Quick and dirty imputation of missing values.
impute-method	Quick and dirty imputation of missing values.
incrementDimScale	Classes and functions that are exported but that are not part of the API.
incrementDimScale-method	Classes and functions that are exported but that are not part of the API.
inferDimScale	Classes and functions that are exported but that are not part of the API.
internal-methods	Internal methods
intervalContainsTruth	Test whether intervals contain true values
intervalContainsTruth-method	Test whether intervals contain true values
intervalScore	Interval score, a measure of forecast quality
intervalScore-method	Interval score, a measure of forecast quality
intervalWidth	Calculate the widths of credible intervals
intervalWidth-method	Calculate the widths of credible intervals
isConsistent	Test whether a demographic account is internally consistent.
isConsistent-method	Test whether a demographic account is internally consistent.
isPositiveIncrement	Classes and functions that are exported but that are not part of the API.
isPositiveIncrement-method	Classes and functions that are exported but that are not part of the API.

-- L --

labels-method	Internal methods
length-method	Internal methods
limits	First and last categories used by each dimension.
limits-method	First and last categories used by each dimension.

-- M --

mad-method	Existing statistical functions.
makeAxStart	Classes and functions that are exported but that are not part of the API.
makeCollapseTransformExtra	Classes and functions that are exported but that are not part of the API.
makeCompatible	Classes and functions that are exported but that are not part of the API.
makeCompatible-method	Classes and functions that are exported but that are not part of the API.
makeConsistent	Make a demographic account internally consistent.
makeConsistent-method	Make a demographic account internally consistent.
makeMetaDataSubarraysBefore	Classes and functions that are exported but that are not part of the API.
makeTransform	Classes and functions that are exported but that are not part of the API.
makeTransform-method	Classes and functions that are exported but that are not part of the API.
ManyToOne-class	S4 class for holding concordances.
mean-method	Existing statistical functions.
median-method	Existing statistical functions.
MetaData-class	Classes and functions that are exported but that are not part of the API.
midpoints	Replace intervals by their midpoints.
midpoints-method	Replace intervals by their midpoints.
Movements	Create a demographic account based on movements.
Movements-class	Classes "DemographicAccount", "Movements", "Transitions"
MSE	MSE (Mean Squared Error)
MSE-method	MSE (Mean Squared Error)

-- N --

names-method	Get or set dimension names
names-methods	Get or set dimension names
names<--method	Get or set dimension names
Net	Create object of class "Net" and "Pool".
Net-class	Classes to summarise origin-destination flows.
Net-method	Create object of class "Net" and "Pool".
net-pool-classes	Classes to summarise origin-destination flows.
net-pool-generators	Create object of class "Net" and "Pool".
nIteration	Get the number of iterations in a demographic array.
nIteration-method	Get the number of iterations in a demographic array.

-- O --

OneToOne-class	S4 class for holding concordances.
Ops-method	Internal methods

-- P --

pairAligned	Test whether pairs of dimensions aligned.
pairAligned-method	Test whether pairs of dimensions aligned.
pairToState	Convert dimensions with paired dimtypes to state dimtypes
pairToState-method	Convert dimensions with paired dimtypes to state dimtypes
perturb	Generate demographic array consisting of random values.
perturb-method	Generate demographic array consisting of random values.
plot-method	Plot a demographic array
plot-methods	Plot a demographic array
Pool	Create object of class "Net" and "Pool".
Pool-class	Classes to summarise origin-destination flows.
Pool-method	Create object of class "Net" and "Pool".
population	Extract population counts from a demographic account.
population-method	Extract population counts from a demographic account.
prop.table	Calculate proportions within dimensions of a demographic array.
prop.table-method	Calculate proportions within dimensions of a demographic array.

-- R --

reallocateToEndAges	Reallocate counts or values to youngest and oldest age groups.
reallocateToEndAges-method	Reallocate counts or values to youngest and oldest age groups.
recodeCategories	Change category labels
recodeCategories-method	Change category labels
redistribute	Randomly allocate counts in proportion to weights.
redistribute-method	Randomly allocate counts in proportion to weights.
redistributeCategory	Redistribute values from one or more categories among the remaining categories.
redistributeCategory-method	Redistribute values from one or more categories among the remaining categories.
resetDiag	Reset values where origin equals destination.
resetDiag-method	Reset values where origin equals destination.
resetIterations	Reset iteration labels.
resetIterations-method	Reset iteration labels.
rotateAgeTime	Rotate the age-time plan used by a demographic array
rotateAgeTime-method	Rotate the age-time plan used by a demographic array
round3	Randomly round a dataset to base 3.
round3-method	Randomly round a dataset to base 3.

-- S --

setAgeMax	Get or set minimum and maximum ages.
setAgeMax-method	Get or set minimum and maximum ages.
setAgeMin	Get or set minimum and maximum ages.
setAgeMin-method	Get or set minimum and maximum ages.
setComponentNames	Get or set the names of components of a demographic account.
setComponentNames-method	Get or set the names of components of a demographic account.
show-method	S4 class for holding concordances.
show-method	Internal methods
slab	Extract or replace a slab from a demographic array.
slab-method	Extract or replace a slab from a demographic array.
slab<-	Extract or replace a slab from a demographic array.
slab<--method	Extract or replace a slab from a demographic array.
splice	Splice concordances.
Statistical-Functions	Existing statistical functions.
stepLengths	Classes and functions that are exported but that are not part of the API.
stepLengths-method	Classes and functions that are exported but that are not part of the API.
subarray	Subset a demographic array.
subarray-method	Subset a demographic array.
subtotals	Get subtotals attached to a Counts object.
subtotals-method	Get subtotals attached to a Counts object.
Summary-method	Existing statistical functions.
summary-method	Internal methods
SummaryDemographicArray-class	exported-not-api

-- T --

t-method	Internal methods
tfr	Calculate total fertility rates.
tfr-method	Calculate total fertility rates.
thinIterations	Reduce the number of iterations in demographic array.
thinIterations-method	Reduce the number of iterations in demographic array.
timeToPeriod	Convert years to periods
toDouble	Coerce to numeric or integer.
toDouble-method	Coerce to numeric or integer.
toInteger	Coerce to numeric or integer.
toInteger-method	Coerce to numeric or integer.
Transform-class	Classes and functions that are exported but that are not part of the API.
Transitions-class	Classes "DemographicAccount", "Movements", "Transitions"
translate	Translate between classifications.
translate-method	Translate between classifications.

-- U --

unname-method

Internal methods

-- V --

Values	Create objects of class "Counts" or "Values".
Values-class	Classes "DemographicArray", "Counts", and "Values".
Values-method	Create objects of class "Counts" or "Values".
ValuesOne	Create one-dimensional object of class "Counts" or "Values"

-- misc --

%in%-method	Internal methods
[-method	Internal methods