View source: R/di_iterate_sql.R
di_calc_sql | R Documentation |
Generate SQL code that calculates disproportionate impact via the percentage point gap (PPG), proportionality index, and 80% index methods for a specified table name, success variable, group variable, and cohort variable. This is the workhorse function leveraged by the di_iterate_sql function.
di_calc_sql( db_table_name, success_var, group_var, cohort_var = "", weight_var = 1, ppg_reference_group = "overall", min_moe = 0.03, use_prop_in_moe = FALSE, prop_sub_0 = 0.5, prop_sub_1 = 0.5, di_prop_index_cutoff = 0.8, di_80_index_cutoff = 0.8, di_80_index_reference_group = "hpg", before_with_statement = "", after_with_statement = "", end_of_select_statement = "", where_statement = "", select_statement_add = "" )
db_table_name |
A character value specifying a database table name. |
success_var |
A character value specifying the success variable name. |
group_var |
A character value specifying the group (disaggregation) variable name. |
cohort_var |
(Optional) A character value specifying the cohort variable. If not specified, then a single cohort is assumed (defaults to an empty string, |
weight_var |
(Optional) A character variable specifying the weight variable if the input data set is summarized (i.e., the the success variables specified in |
ppg_reference_group |
Either |
min_moe |
The minimum margin of error to be used in the PPG calculation; see di_ppg. |
use_prop_in_moe |
( |
prop_sub_0 |
Default is 0.50; see di_ppg. |
prop_sub_1 |
Default is 0.50; see di_ppg. |
di_prop_index_cutoff |
Threshold used for determining disproportionate impact using the proportionality index; see di_prop_index; defaults to 0.80. |
di_80_index_cutoff |
Threshold used for determining disproportionate impact using the 80% index; see di_80_index; defaults to 0.80. |
di_80_index_reference_group |
Either |
before_with_statement |
Character value to be added to the SQL query to allow for modification. Defaults to |
after_with_statement |
Character value to be added to the SQL query to allow for modification. Defaults to |
end_of_select_statement |
Character value to be added to the SQL query to allow for modification. Defaults to |
where_statement |
Character value to be added to the SQL query to allow for modification. Defaults to |
select_statement_add |
Character value to be added to the SQL query to allow for modification. Defaults to |
A character value (SQL query) that could be executed on a database.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.