suppress_single_group: Suppress an input dataframe (with some additional options)

In moj-analytical-services/mojSuppression: Suppression Code for usage within the Ministry of Justice

Suppress an input dataframe (with some additional options)

Description

This fuction offers a way for users to suppression rows, columns or both rows and columns simultaneously. For a more streamlined version (without some features, but easier to use), please see 'simple_suppression'.

Usage

suppress_single_group(
  df,
  where_to_suppress = c("col"),
  cols_to_suppress = NULL,
  row_nos_to_suppress = NULL,
  suppression_thres,
  suppress_0 = TRUE,
  inc_secondary_suppression = TRUE,
  suppression_output_value = 9999999,
  subset_df_along_row_and_col_arguments = TRUE,
  columns_to_pseudo_suppress = NULL,
  rows_to_pseudo_suppress = NULL,
  pseudo_suppression_threshold = NULL,
  pseudo_suppress_0 = NULL,
  priority_row_suppression = NULL,
  ordered_priority_suppression = FALSE,
  suppression_pre_applied = FALSE,
  total_suppression = FALSE,
  indirect_suppression = FALSE,
  secondary_suppress_0 = TRUE
)

Arguments

df	Specify dataframe to suppress on
where_to_suppress	Which orientation you'd like to suppress on. For both row and column suppression, please use: c("row", "col")
cols_to_suppress	Columns to suppress on. These should be presented in the following format: 'c("col1", "col2", ...)' If no value is entered, all columns will automatically be selected for suppression. If a non-numeric column is selected, the code will forcefully stop the process
row_nos_to_suppress	Rows to be suppressed along. These should be numeric values: 'c(1:3)', for example. If no value is entered, all rows will be automatically selected for suppression.
suppression_thres	This is your threshold value to determine which values should be suppressed. Values equal to, or below this value will be suppressed.
suppress_0	Whether to suppress 0s or not. TRUE is the default and will suppress all 0s
inc_secondary_suppression	Flag to select whether only primary or secondary suppression is applied. Secondary suppression is the default.
suppression_output_value	Set a value to output where suppression has occurred. It is advised you set this to a numeric value (or leave at the default) while working with your data in R, as setting the output to '~' will set your column to a character class.
secondary_suppress_0	Specify whether 0 can be used for secondary suppression or not. If TRUE, 0s will be suppressed when secondary suppression is performed

Details

The 'suppress_single_group()' function can be used to apply both primary or secondary suppression across a selection of either rows or columns, suppressing all values below a specified suppression threshold. This funtion expects that the input be your final dataframe that you wish to suppress on. Please filter down your existing work, should it not meet this criteria.

The 'suppress_single_group()' function offers more functionality than the alternative, 'simple_suppression', at the cost of being slightly less intuitive and more daunting for new users. If you need any of the following rules, please use this function, otherwise you may be better served by the 'simple_suppression' function: * total suppression - i.e. where total suppression nodes sum to <= suppression threshold and more suppression is necessary * priority suppression - where you want certain rows to take precedence for your secondary suppression * pseudo suppression - where you have columns you don't want to be actively suppressed, but if their values fall below your suppression threshold other columns need suppression

Examples

# Create our test df
bme <- c(25, 1, 1, 10)
white <- c(10, 6, 10, 1)
other <- c(1, 5, 10, 10)
test <- c(5, 6, 4, 3)

df <- data.frame(bme = bme,
                 white = white,
                 other = other,
                 test = test)

# simple example for suppressing across all rows and columns
mojSuppression::suppress_single_group(
    df = df,
    where_to_suppress = c('col', 'row'),
    suppression_thres = 2
)

moj-analytical-services/mojSuppression documentation built on Aug. 27, 2022, 11:14 p.m.