write.projection.summary {bayesTFR}R Documentation

Writing Projection Summary Files


The function creates two files containing projection summaries, such as the median, the lower and upper bound of the 80 and 90% probability intervals, respectively, the +/- 0.5 child variant and the constant variant. One file is in a user-friendly format, whereas the other is in a UN-specific format with internal coding of the time and the variants. In addition, a file containing some of the model parameters is created.


write.projection.summary(dir = file.path(getwd(), "bayesTFR.output"), 
    output.dir = NULL, revision = NULL, adjusted = FALSE, est.uncertainty = FALSE, ...)



Directory containing the prediction object. It should correspond to the output.dir argument of the tfr.predict function.


Directory in which the resulting file will be stored. If NULL the same directory is used as for the prediction.


UN WPP revision number. If NULL it is determined from the corresponding WPP year: WPP 2008 corresponds to revision 13, every subsequent WPP increases the revision number by one. Used as a constant in the second file only.


Logical. By default the function writes summary using the original BHM projections. If the projection medians are adjusted (using e.g. tfr.median.set), setting this argument to TRUE causes writing the adjusted projections.


Logical. If TRUE and the simulation was generated with uncertainty around estimation, that uncertainty info is included in the summaries.


Additional arguments passed to the underlying functions. Here, argument precision can be set to determine the number of significant digits (default is 4).


The first file that the function creates is called ‘projection_summary_user_friendly.csv’ (or ‘projection_summary_user_friendly_adjusted.csv’ if adjusted=TRUE), it is a comma-separated table with the following columns:

The second file, called ‘projection_summary.csv’ (or ‘projection_summary_adjusted.csv’ if adjusted=TRUE), also comma-separated table, contains the same information as above in a UN-specific format:

The third comma-separated file, called ‘projection_summary_parameters.csv’ contains the following columns:

Note that this file is not created if adjusted=TRUE.


This function is automatically called from the tfr.predict function, therefore in standard cases it will not be needed to call it directly.


Hana Sevcikova

See Also

convert.tfr.trajectories, tfr.predict

[Package bayesTFR version 7.2-0 Index]