plot.causalWeights {causalOT}R Documentation

plot.causalWeights

Description

plot.causalWeights

Usage

## S3 method for class 'causalWeights'
plot(
  x,
  r_eff = NULL,
  penalty,
  p = 2,
  cost = NULL,
  debias = TRUE,
  online.cost = "auto",
  diameter = NULL,
  niter = 1000,
  tol = 1e-07,
  ...
)

Arguments

x

A causalWeights object

r_eff

The r_\text{eff} to use for the PSIS_diag() function.

penalty

The penalty of the optimal transport distance to use. If missing or NULL, the function will try to guess a suitable value depending if debias is TRUE or FALSE.

p

L_p distance metric power

cost

Supply your own cost function. Should take arguments x1, x2, and p.

debias

TRUE or FALSE. Should the debiased optimal transport distances be used.

online.cost

How to calculate the distance matrix. One of "auto", "tensorized", or "online".

diameter

The diameter of the metric space, if known. Default is NULL.

niter

The maximum number of iterations for the Sinkhorn updates

tol

The tolerance for convergence

...

Not used at this time

Details

The plot method first calls summary.causalWeights on the causalWeights object. Then plots the diagnostics from that summary object.

Value

The plot method returns an invisible object of class summary_causalWeights.

See Also

summary.causalWeights()


[Package causalOT version 1.0.2 Index]