z_test_BFF {BFF} | R Documentation |

## z_test_BFF

### Description

z_test_BFF constructs BFFs based on the z test. BFFs depend on hyperparameters r and tau^2 which determine the shape and scale of the prior distributions which define the alternative hypotheses. By setting r > 1, we use higher-order moments for replicated studies. Fractional moments are set with r > 1 and r not an integer. All results are on the log scale.

### Usage

```
z_test_BFF(
z_stat,
n = NULL,
n1 = NULL,
n2 = NULL,
one_sample = FALSE,
alternative = "two.sided",
omega = NULL,
omega_sequence = if (is.null(omega)) seq(0.01, 1, by = 0.01),
r = 1
)
```

### Arguments

`z_stat` |
Z statistic |

`n` |
sample size (if one sample test) |

`n1` |
sample size of group one for two sample test. Must be provided if one_sample = FALSE |

`n2` |
sample size of group two for two sample test. Must be provided if one_sample = FALSE |

`one_sample` |
is test one sided? Default is FALSE |

`alternative` |
the alternative. options are "two.sided" or "less" or "greater" |

`omega` |
standardized effect size. For the z-test, this is often called Cohen's d (can be a single entry or a vector of values) |

`omega_sequence` |
sequence of standardized effect sizes. If no omega is provided, omega_sequence is set to be seq(0.01, 1, by = 0.01) |

`r` |
variable controlling dispersion of non-local priors. Default is 1. |

### Value

Returns an S3 object of class 'BFF' (see 'BFF.object' for details).

### Examples

```
zBFF = z_test_BFF(z_stat = 2.5, n = 50, one_sample = TRUE)
zBFF
plot(zBFF)
```

*BFF*version 4.2.1 Index]