API Reference

API Reference#

Modified Detecting Deviating Data Cells (MDDC)#

find_optimal_coef(contin_table[, rep, ...])

Find Adaptive Boxplot Coefficient coef via Grid Search.

mddc(contin_table[, method, rep, quantile, ...])

Modified Detecting Deviating Cells (MDDC) algorithm for adverse event signal identification.

Utility Functions#

generate_contin_table_with_clustered_AE(...)

Generate simulated contingency tables with optional incorporation of adverse event correlation within clusters.

generate_contin_table_with_clustered_AE_with_tol(...)

Generate simulated contingency tables with the option of incorporating adverse event correlation within clusters and tolerance for total report count.

report_drug_AE_pairs(contin_table, ...[, ...])

Report potential adverse events for drugs/vaccines based on the contingency table.

plot_heatmap(data[, size_cell])

Plot a heatmap of the specified attribute from the mddc_result.

Datasets#

load_statin49_data([desc, as_dataframe])

A 50 by 7 data matrix of a contingency table processed from FDA Adverse Event Reporting System (FAERS) database from the third quarter of 2014 to the fourth quarter of 2020.

load_statin49_cluster_idx_data([desc, ...])

A 50 by 7 data matrix of a contingency table processed from FDA Adverse Event Reporting System (FAERS) database from the third quarter of 2014 to the fourth quarter of 2020; this dataset also contains the cluster index of the various adverse events.

load_statin101_data([desc, as_dataframe])

A 102 by 5 data matrix of a contingency table processed from FDA Adverse Event Reporting System (FAERS) database from the first quarter of 2021 to the fourth quarter of 2023.

load_betablocker500_data([desc, as_dataframe])

A 501 by 9 data matrix of a contingency table processed from FDA Adverse Event Reporting System (FAERS) database from the first quarter of 2021 to the fourth quarter of 2023.

load_sedative1000_data([desc, as_dataframe])

A 1001 by 11 data matrix of a contingency table processed from FDA Adverse Event Reporting System (FAERS) database from the first quarter of 2021 to the fourth quarter of 2023.
Contents