exported-not-api: Classes and functions that are exported but that are not part...

In StatisticsNZ/dembase: Analysing Cross-Classified Data about Populations

Description

The classes functions listed below are exported, so that they can be used internally by other packages such as demest. However, they do not form part of API for the package dembase. They should not be needed in normal interactive use.

Usage

DimScales(object, use.names = TRUE)

DimScales(object) <- value

canMakeCompatible(
  x,
  y,
  subset = FALSE,
  concordances = list(),
  allowCopyIterDim = TRUE
)

collapse(object, transform, concordances = list())

extend(object, transform)

incrementDimScale(object, n)

isPositiveIncrement(object)

makeCompatible(x, y, subset = FALSE, concordances = list(), check = TRUE)

makeTransform(x, y, subset = FALSE, concordances = list(), check = TRUE)

stepLengths(object)

## S4 method for signature 'Births'
isPositiveIncrement(object)

## S4 method for signature 'Internal'
isPositiveIncrement(object)

## S4 method for signature 'Entries'
isPositiveIncrement(object)

## S4 method for signature 'Exits'
isPositiveIncrement(object)

## S4 method for signature 'NetMovements'
isPositiveIncrement(object)

## S4 method for signature 'Counts,DemographicArray'
canMakeCompatible(
  x,
  y,
  subset = FALSE,
  concordances = list(),
  allowCopyIterDim = TRUE
)

## S4 method for signature 'Counts,CollapseTransform'
collapse(object, transform, concordances = list())

## S4 method for signature 'Counts,DemographicArray'
makeCompatible(x, y, subset = FALSE, concordances = list(), check = TRUE)

## S4 method for signature 'Counts,DemographicArray'
makeTransform(x, y, subset = FALSE, concordances = list(), check = TRUE)

## S4 method for signature 'Counts,numeric'
makeTransform(x, y, subset = FALSE, check = TRUE)

## S4 method for signature 'DemographicAccount'
DimScales(object, use.names = TRUE)

## S4 method for signature 'DemographicAccount'
dimtypes(object, use.names = TRUE)

## S4 method for signature 'DemographicArray'
DimScales(object, use.names = TRUE)

## S4 method for signature 'DimScale'
incrementDimScale(object, n)

## S4 method for signature 'DimScale'
stepLengths(object)

## S4 method for signature 'Intervals'
incrementDimScale(object, n)

## S4 method for signature 'Intervals'
stepLengths(object)

## S4 method for signature 'MetaData,CollapseTransform'
collapse(object, transform, concordances = list())

## S4 method for signature 'MetaData'
DimScales(object, use.names = TRUE)

## S4 method for signature 'Points'
incrementDimScale(object, n)

## S4 method for signature 'Points'
stepLengths(object)

## S4 method for signature 'Quantiles'
stepLengths(object)

## S4 method for signature 'Values,DemographicArray'
canMakeCompatible(x, y, subset = FALSE, concordances)

## S4 method for signature 'Values,CollapseTransform'
collapse(object, transform, concordances = list())

## S4 method for signature 'Values,DemographicArray'
makeCompatible(x, y, subset = FALSE, concordances = list(), check = TRUE)

## S4 method for signature 'Values,DemographicArray'
makeTransform(x, y, subset = FALSE, concordances = list(), check = TRUE)

## S4 method for signature 'numeric,Values'
makeTransform(x, y, subset = FALSE, check = TRUE)

## S4 method for signature 'array,CollapseTransform'
collapse(object, transform)

## S4 method for signature 'array,ExtendTransform'
extend(object, transform)

checkAndTidyAlong(
  along,
  metadata,
  numericDimScales,
  checkNumericDimscales = TRUE
)

iFemale(DimScale)

iMale(DimScale)

makeCollapseTransformExtra(transform)

getIAfter(i, transform, check = TRUE, useC = FALSE)

getIBefore(i, transform, useC = FALSE)

getIShared(i, transform, useC = FALSE)

makeMetaDataSubarraysBefore(metadata, transform)

checkAge(
  object,
  minAges = 2L,
  regular = FALSE,
  openLeftOK = FALSE,
  openRightOK = FALSE,
  expectedDimscale = "Intervals"
)

inferDimScale(dimtype, dimscale = NULL, labels, name)

addIterationsToMetadata(object, iterations)

exposureHMD(object)

expandAx(ax, object)

makeAxStart(mx)

## S4 method for signature 'numeric,ExtendTransform'
extend(object, transform)

Arguments

object	Typically an object of class DemographicArray.
use.names	Logical. Whether to return a named vector.
value	Replacement value.
x	First element. Typically an object of class DemographicArray.
y	Second element. Typically an object of class DemographicArray.
subset	Logical. Whether to allow transformations that return a subset of all cells.
concordances	A list of objects of class Concordance.
allowCopyIterDim	Logical. Whether to allow an iteration dimension to be copied from one element to the other, if one element has an iterations dimension but the other does not.
transform	An object of class Transform.
n	Number of increments.
check	Logical. Whether to check if transformation can be performed before trying to perform it.
along	Name or index of dimension.
metadata	An object of class MetaData.
numericDimScales	Logical. Whether to require that along dimension have dimscale "Points" or "Intervals".
checkNumericDimscales	Whether to require 'along' dimension to have a numeric dimscale.
DimScale	An object of class DimScale.
i	Integer. Index for cell within.
useC	Logical. Whether to call the C function, or use the R equivalent.
minAges	Integer. Minimum length for age dimension.
regular	Logical. Whether age or time steps must have equal lengths.
openLeftOK	Logical. Whether the first age group can be open (ie have no minimum age.)
openRightOK	Logical. Whether the last age group can be open (ie have no minimum age.)
expectedDimscale	Name of a dimscale.
dimtype	A dimtype.
dimscale	A dimscale.
labels	A character vector with labels for a dimension.
name	Character. A dimension name.
iterations	Integer. The iteractions to extract.
ax	Separation factors.
mx	Mortality rates.

StatisticsNZ/dembase documentation built on Dec. 25, 2021, 4:49 p.m.