dp.inputs.use.external.pop: Check whether an external population was specified
In rlglaubius/SpectrumUtils: Utilities for reading Spectrum files (Title Case)
dp.inputs.use.external.pop R Documentation
Check whether an external population was specified
Description
Spectrum users may enter externally-produced population targets by sex, age,
and year that can be used to align Spectrum population outputs with a
reference population projection. dp.inputs.use.external.pop indicates
whether this mechanism was used.
Usage
dp.inputs.use.external.pop(dp.raw, direction = "wide")
Arguments
dp.raw
DemProj module data in raw format, as returned by
read.raw.dp()
direction
Ignored; included for compatibility with similar functions.
Value
A list with two elements. Element use.external.pop is TRUE if
an external population was used, FALSE otherwise. Element final.year
specifies the final year of adjustments.
Details
Use of an external population file is optional and rare in Spectrum.
Projections that use this mechanism may specify that adjustments to match
external population targets are not done in every year, but only until a
specified final year. Use dp.inputs.external.pop to access the
external population sizes.
rlglaubius/SpectrumUtils documentation built on Dec. 20, 2024, 7:31 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| dp.inputs.use.external.pop | R Documentation |
Check whether an external population was specified
Description
Spectrum users may enter externally-produced population targets by sex, age,
and year that can be used to align Spectrum population outputs with a
reference population projection. dp.inputs.use.external.pop indicates
whether this mechanism was used.
Usage
dp.inputs.use.external.pop(dp.raw, direction = "wide")
Arguments
dp.raw |
DemProj module data in raw format, as returned by
|
direction |
Ignored; included for compatibility with similar functions. |
Value
A list with two elements. Element use.external.pop is TRUE if
an external population was used, FALSE otherwise. Element final.year
specifies the final year of adjustments.
Details
Use of an external population file is optional and rare in Spectrum.
Projections that use this mechanism may specify that adjustments to match
external population targets are not done in every year, but only until a
specified final year. Use dp.inputs.external.pop to access the
external population sizes.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.