# Test the significance of a p-value

### Description

Test if a p-value is significant. This is specifically designed
to handle numeric output, or output from `pvalString`

### Usage

1 | ```
is_significant(pvalue, alpha = 0.05)
``` |

### Arguments

`pvalue` |
The p-value to be tested |

`alpha` |
The significance level for comparison |

### Details

In instances where `pvalue`

has a leading '<' or '>',
the inequality is stripped and the remaining characters are coerced to
a numeric. A logical vector comparing pvalue to alpha is returned
where the value is `TRUE`

if `pvalue`

<= `alpha`

This function was built with the intent of using it to identify rows
in descriptive tables (such as `cattable`

and `conttable`

)
with significant results. These rows could then be highlighted
using bold print automatically. This might prove useful for large tables.

### Author(s)

Benjamin Nutter

### Examples

1 2 3 4 5 | ```
## Not run:
is_significant(c(.10, .06, .051, .05, .049, .02, .01))
is_significant(c("> .10", "< .05", "< 0.001"), alpha=.01)
## End(Not run)
``` |

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker. Vote for new features on Trello.