A package to simplify downloading, caching and updating POLIS data. Functions to clarify agency specific pre-processing and data cleaning steps are also included.
First make sure you have devtools installed. Then run the following command:
devtools::install_github("nish-kishore/tidypolis")
After you can use any function developed in this package using
tidypolis::{function}
Here is a current list of core functions included in tidypolis with
brief descriptions. The list is not exhaustive, and many more functions are available
to the users. Please refer to the package index for full function specifications.
- Use the
tidypolis::init_tidypolis()function to create a folder to store and update POLIS data. You must specify if you wish the folder to be stored locally or on the EDAV environment by setting theedavparameter in the function toTRUEorFALSE. - This function will ask for your POLIS API key so please have this ready
- Use the
tidypolis::get_polis_data()to pull all POLIS data and reconcile any missing or updated information, the data will be stored in the local folder or in the EDAV environment you've specified. - Use
tidypolis::preprocess_data()to process all POLIS data with cleaning methodologies used by the SIR team. The function can be used both locally and in the EDAV environment, for CDC employees. - User
tidypolis::process_spatial()to process a WHO geodatabase with cleaning methdologies used by the SIR team.
- Please see the Releases page for specifics on previous releases.
Please send a message to Nishant Kishore are ynm2@cdc.gov for any questions or queries.
This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This repository is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication. All contributions to this repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.
The repository utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later.
This source code in this repository is free: you can redistribute it and/or modify it under the terms of the Apache Software License version 2, or (at your option) any later version.
This source code in this repository is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software License for more details.
You should have received a copy of the Apache Software License along with this program. If not, see http://www.apache.org/licenses/LICENSE-2.0.html
The source code forked from other open source projects will inherit its license.
This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the Disclaimer and Code of Conduct. For more information about CDC's privacy policy, please visit http://www.cdc.gov/other/privacy.html.
Anyone is encouraged to contribute to the repository by forking and submitting a pull request. (If you are new to GitHub, you might start with a basic tutorial.) By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the Apache Software License v2 or later.
All comments, messages, pull requests, and other submissions received through CDC including this GitHub page may be subject to applicable federal law, including but not limited to the Federal Records Act, and may be archived. Learn more at http://www.cdc.gov/other/privacy.html.
This repository is not a source of government records, but is a copy to increase collaboration and collaborative potential. All government records will be published through the CDC web site.