Volcano Plot axis Options

Usage

ae_volcano_opts(
  datain,
  trt1_label = "Control",
  trt2_label = "Exposure",
  statistic = "Risk Ratio",
  pvalue_trans = "none",
  xref_offset = 1
)

Arguments

datain: Input data for volcano plot
trt1_label: Control Treatment label
trt2_label: Other treatment label
statistic: Statistic used for risk analysis
pvalue_trans: Required pvalue transformation. Values: "none"/"-log10"
xref_offset: Offset value for X axis reference line; offset from 0 is statistic is Risk Difference and from 1 if statistic is Risk Ratio.

Value

List of volcano-specific options

Examples

data("adae")

ae_pre <- ae_pre_processor(
  datain = adae,
  obs_residual = 0,
  fmq_data = NA
)

ae_entry <- mentry(
  datain = ae_pre$data,
  subset = NA,
  byvar = "AEBODSYS",
  trtvar = "TRTA",
  trtsort = "TRTAN",
  subgrpvar = NA,
  trttotalyn = "N",
  add_grpmiss = "N",
  sgtotalyn = "N",
  pop_fil = "SAFFL"
)

ae_risk <- risk_stat(
  datain = ae_entry,
  a_subset = ae_pre$a_subset,
  summary_by = "Patients",
  eventvar = "AEDECOD",
  ctrlgrp = "Placebo",
  trtgrp = "Xanomeline High Dose",
  statistics = "Risk Ratio",
  alpha = 0.05,
  cutoff_where = "FREQ >5",
  sort_opt = "Ascending",
  sort_var = "Count"
)
#> mcatstat success
ae_volcano_opts(ae_risk,
  pvalue_trans = "-log10"
)
#> $xaxis_label
#> <--- Favors Control (N=62) ---- Favors Exposure (N=69) --->
#> Risk Ratio
#> 
#> $yaxis_label
#> [1] "-log10 p-value"
#> 
#> $ylinearopts
#> $ylinearopts$breaks
#>  [1] 1e+00 1e-01 1e-02 1e-03 1e-04 1e-05 1e-06 1e-07 1e-08 1e-09 1e-10 1e-11
#> [13] 1e-12 1e-13 1e-14 1e-15 1e-16 1e-17 1e-18 1e-19 1e-20
#> 
#> $ylinearopts$labels
#>  [1] "0"  "1"  "2"  "3"  "4"  "5"  "6"  "7"  "8"  "9"  "10" "11" "12" "13" "14"
#> [16] "15" "16" "17" "18" "19" "20"
#> 
#> 
#> $yaxis_scale
#> Transformer: reverselog-10 [1e-100, Inf]
#> 
#> $xref
#> [1] 1 0 2
#>