diff --git a/.Rbuildignore b/.Rbuildignore index a900f21..c9c4c79 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -7,3 +7,4 @@ ^docs$ ^pkgdown$ ^\.github$ +^vignettes/articles$ diff --git a/DESCRIPTION b/DESCRIPTION index 93810f4..7cff631 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -24,3 +24,4 @@ Imports: Remotes: CDCGov/sirfunctions URL: https://cdcgov.github.io/survpopdata/ +Config/Needs/website: rmarkdown diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 8dada3e..0000000 --- a/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/README.md b/README.md index be2d249..fd06d1e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# CDCgov GitHub Organization Open Source Project Template +# survpopdata R package **General disclaimer** This repository was created for use by CDC programs to collaborate on public health related projects in support of the [CDC mission](https://www.cdc.gov/about/cdc/#cdc_about_cio_mission-our-mission). GitHub is not hosted by the CDC, but is a third party website used by CDC and its partners to share information and collaborate on software. CDC use of GitHub does not imply an endorsement of any one particular service, product, or enterprise. @@ -17,7 +17,7 @@ ## Overview -This package is used to create the population datasets used in various analyses conducted by teams within the Polio Eradication Branch. +This package is used to create the population datasets used in various analyses conducted by collaborators within GPEI. ## Public Domain Standard Notice This repository constitutes a work of the United States Government and is not diff --git a/vignettes/articles/.gitignore b/vignettes/articles/.gitignore new file mode 100644 index 0000000..097b241 --- /dev/null +++ b/vignettes/articles/.gitignore @@ -0,0 +1,2 @@ +*.html +*.R diff --git a/vignettes/articles/survpopdata.Rmd b/vignettes/articles/survpopdata.Rmd new file mode 100644 index 0000000..a9141ac --- /dev/null +++ b/vignettes/articles/survpopdata.Rmd @@ -0,0 +1,110 @@ +--- +title: "Getting started with survpopdata" +--- + +```{r, include = FALSE} +knitr::opts_chunk$set( + collapse = TRUE, + comment = "#>" +) +``` + +```{r setup} +library(survpopdata) +``` + +## Introduction + +The `survpopdata` package attempts to standardize the data cleaning of the population data used in GPEI analyses. For example, it ensures that the geographic names are consistent with the WHO geodatabase. In addition, perform de-duplication wherever it is needed. Finally, it attempts to fill in missing population data using population patches provided by regional partners, or using growth rates. + +## Pre-requisite files + +Several patch files are required for cleaning the district population. For information on the patch files used during the cleaning process, refer to the [Patch files](Patch-files) section of the [Appendix](Appendix). Patch files are required to run the cleaning step, and they should be requested from the CDC SIR team. Please contact Stephanie Kovacs at [uvx4\@cdc.gov](mailto:uvx4@cdc.gov){.email} for these files. + +In addition, cleaned country, province, and district shape files are required. The WHO geodatabase is available in [POLIS](https://extranet.who.int/polis), under **Documents > GIS Releases**, or can be requested from Oluwadamilola Obafemi Sonoiki at [sonoikio\@who.int](mailto:sonoikio@who.int){.email}. The cleaned country, province, and district shapefiles are produced by passing the geodatabase (.gdb) folder to the tidypolis::process_spatial() function. + +The [tidypolis](https://github.com/CDCgov/tidypolis) R package is required to produce these shape files and more information can be found in the function description. Please see `?tidypolis::process_spatial()` after downloading the tidypolis package. + +## Downloading the POLIS population dataset + +There are several ways to obtain the POLIS population dataset. The code below uses the tidypolis package and is the recommended way of obtaining datasets from the POLIS API. + +``` r +library(tidypolis) +init_tidypolis("C:/Users/abc1/Desktop/POLIS", edav = FALSE) # EDAV for CDC use only + +get_polis_data("pop") + +# The population dataset will be located in C:/Users/abc1/Desktop/POLIS/data/pop.parquet +``` + +## Main functions in survpopdata + + +## Methodology + +The process for building the population dataset at the different administrative levels have different methodologies. However, all the population data starts with the data obtained from the POLIS API and gaps are filled when necessary. + +### District population + +Function: `process_dist_pop_data()` + +The district population are first pulled from the POLIS API population data, and then filtered to only use the Polio Program Population Data (`FK_DatasetId = 2`). Forward-filled records are removed. The growth rates dataset are joined to the population dataset by the country name and year. + +The district shape file and population dataset are then joined using year and Adm2GUID. In instances where geographic names (ADM0_NAME, ADM1_NAME, and ADM2_NAME) are mismatched between the two, the shape file geographic names are used. + +The order of filling in population data from the POLIS API is as follows: Pakistan 2022-2023 Patch \> Somalia 2022-2024 Patch \> Kenya 2018 Patch \> WHO supplementary pop file 2018 - 2022 \> World Pop 2015. These patch fills primarily patches Under 15 population counts. If there are still missing district populations, grow rates are applied to fill in missing data. For a detailed explanation on the growth rate implementation, please see the [Growth rates methodology ](Growth-rate-methodology) section in the [Appendix](Appendix). + +### Province population + +Function: `process_prov_pop_data()` + +Similar to the district population, the province population are pulled from the POLIS API population data, and then filtered to only use the Polio Program Population Data (`FK_DatasetId = 2`). Forward-filled records are removed. The growth rates dataset are joined to the population dataset by the country name and year. + +The province shapefile and population dataset are then joined using year and Adm1GUID. In instances where geographic names (ADM0_NAME and ADM1_NAME) are mismatched between the two, the shape file geographic names are used. + +Missing province populations are first filled using the district population roll-up from the cleaned district population. The district population roll-up only fills in a province if all districts within that province have population data. + +After filling in data using the population roll-up, growth rates are used to fill in additional province population. + +### Country population + +Function: `process_ctry_pop_data()` + +The country population are pulled from the POLIS API population data, and then filtered to only use the UNDP Population Data (`FK_DatasetId = 1`). Forward-filled records are removed. The growth rates dataset are joined to the population dataset by the country name and year. + +The country shapefile and the population dataset are then joined using the year and Adm0GUID. In instances where geographic names (ADM0_NAME) are mismatched between the two, the shape file geographic names are used. + +Growth rates are used to fill additional country population. + +## Checking for unusual changes to population counts + + +## Appendix + +### Growth rate methodology + +For growth rates, there are two ways it is done, using back fill or forward fill, depending on the anchor year. The anchor year is the latest year where data was available. For example, if a district has no population in 2025 but had one in 2024, then the anchor year will be 2024. Similarly, if there was no data in 2023, then the anchor year will be 2024. However, the default will be forward filling. For example, if there was data in 2022, no data in 2023, and data in 2024, the anchor year for 2023 is 2022. The growth rate is then applied based on the anchor value and the growth rate for a particular year. + +For example, 2023 is missing population and we know it had a growth rate of 2%. The previous year, 2022, did have population (say 100K). Therefore we make 2022 the anchor year and 100K the anchor value. Then, the population in 2023 is $100000(1 + 0.02) = 102000$. + +### Patch files + +- **Pakistan 2022-2023 Patch**: + - File name: 2022_2023 Population Pakistan.csv + - Description: 2022 and 2023 under 15 district population for Pakistan received from the CDC Pakistan team. +- **Somalia 2022-2024 Patch**: + - File names: AFPPOP_22.csv, AFPPOP_23.csv, AFPPOP_23.csv + - Description: Somalia under 15 population for 2022 through 2023 received from the WHO EMRO team. +- **Kenya 2018 Patch**: + - File name: Kenya_SubCounty_pop_2018.csv + - Description: Kenya under 15 population for 2018, received from WHO AFRO team. +- **WHO supplementary pop file 2018 - 2022**: + - File name: POPU15.csv + - Description: Supplementary population file received from WHO HQ for 2018 through 2022. +- **World Pop 2015**: + - File name: adm2_2015_pop.csv + - Description: District population for 2015 from World Pop. +- **Growth rate**: + - File name: WPP2024_GEN_F01_DEMOGRAPHIC_INDICATORS_COMPACT.xlsx + - Description: World population prospects country level growth rates. Latest growth rate estimates can be obtained [here](https://population.un.org/wpp/downloads?folder=Standard%20Projections&group=Most%20used).