Skip to contents

List modules

Usage

module_list(module_dir = system.file("modules", package = "papercheck"))

Arguments

module_dir

the directory to search for modules (defaults to the built-in modules)

Value

a data frame of modules

Examples

module_list()
#>  * all_p_values: List all p-values in the text, returning the matched text (e.g., 'p = 0.04')
#> and document location in a table.
#> 
#> Note that this will not catch p-values reported like "the p-value is 0.03" because that results in a ton of false positives when papers discuss p-value thresholds. If you need to detect text like that, use `search_text()` function and a custom pattern like "\\bp(-| )?values?\\s+.{1,20}\\s+[0-9\\.]+"
#> 
#> This will catch most comparators like =<>~≈≠≤≥≪≫ and most versions of scientific notation like 5.0 x 10^-2 or 5.0e-2. If you find any formats that are not correctly handled by this function, please contact the author.
#>  * all_urls: List all the URLs in the main text.
#>  * effect_size: Detect t-tests and F-tests  with missing effect sizes
#>  * exact_p: List any p-values reported with insufficient precision (e.g., p < .05 or p = n.s.)
#>  * marginal: List all sentences that describe an effect as 'marginally significant'.
#>  * osf_check: List all OSF links and whether they are open, closed, or do not exist.
#>  * ref_consistency: Check if all references are cited and all citations are referenced
#>  * retractionwatch: Flag any cited papers in the RetractionWatch database
#>  * statcheck: Check consistency of p-values and test statistics
#>  
#> Use `module_help("module_name")` for help with a specific module