Summary | BigQuery | Terminology | Requirements | Microdata and Record Keys | Perturbation Table (P-table) | User Instructions | Installing the SML method | Using the SML method | How to Use the Method in BigQuery | Worked Example with Synthetic Data (data.table) | Interpreting the Output | Saving the Output | Appendix - Help Pages | Methodology | Additional Information | License
Package: cellkeyperturbation 3.0.0
Ahmet Aydin
cellkeyperturbation: Cell Key Perturbation
Provides functions to generate frequency tables and apply cell key perturbation to protect against statistical disclosure in tabular outputs. The implemented methods are described in "Cell Key Perturbation User Guide" <https://github.com/ONSdigital/cell-key-perturbation-R/blob/main/documentation/SML_UserDoc_CKP_R.md>. Developed at the UK Office for National Statistics.
Authors:
cellkeyperturbation_3.0.0.tar.gz
cellkeyperturbation_3.0.0.zip(r-4.7-any)cellkeyperturbation_3.0.0.zip(r-4.6-any)cellkeyperturbation_3.0.0.zip(r-4.5-any)
cellkeyperturbation_3.0.0.tgz(r-4.6-any)cellkeyperturbation_3.0.0.tgz(r-4.5-any)
cellkeyperturbation_3.0.0.tar.gz(r-4.7-any)cellkeyperturbation_3.0.0.tar.gz(r-4.6-any)
cellkeyperturbation_3.0.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
cellkeyperturbation/json (API)
| # Install 'cellkeyperturbation' in R: |
| install.packages('cellkeyperturbation', repos = c('https://onsdigital.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/onsdigital/cell-key-perturbation-r/issues
Datasets:
- micro - Example data
- ptable_10_5 - Perturbation table
Last updated from:2187cf1201. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel | OK | 114 | ||
| source / vignettes | OK | 158 | ||
| linux-release | OK | 96 | ||
| macos-release | OK | 126 | ||
| macos-oldrel | OK | 97 | ||
| windows-devel | OK | 88 | ||
| windows-release | OK | 73 | ||
| windows-oldrel | OK | 77 | ||
| wasm-release | OK | 90 |
Exports:create_perturbed_tablecreate_perturbed_table_bigquerygenerate_ptable_10_5_rulegenerate_random_rkeygenerate_test_datavalidate_inputs
Dependencies:data.table
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Check perturbed table for missingness in tabulation variables | check_for_na |
| Create a frequency table with cell key perturbation applied | create_perturbed_table |
| Create a perturbed frequency table in BigQuery and return it as a data frame | create_perturbed_table_bigquery |
| Generate ptable (10-5 rule) | generate_ptable_10_5_rule |
| Generate and attach random record keys to microdata | generate_random_rkey |
| Generate Record Key from ONS ID | generate_record_key_from_ons_id |
| Generate sample microdata | generate_test_data |
| Example data (micro) | micro |
| Perturbation table | ptable_10_5 |
| Validate Inputs Before Perturbation using BigQuery | validate_inputs_bigquery |