Skip to contents

Get module information

Usage

module_info(module)

Arguments

module

the name of a module or path to a module

Value

a list of module info

Examples

module_info("all_p_values")
#> $title
#> [1] "List All P-Values"
#> 
#> $description
#> [1] "List all p-values in the text, returning the matched text (e.g., 'p = 0.04')\nand document location in a table.\n\nNote 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\\\\.]+\"\n\nThis 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."
#> 
#> $author
#> [1] "Lisa DeBruine (debruine@gmail.com)"
#> 
#> $param
#> $param[[1]]
#> $param[[1]]$name
#> [1] "paper"
#> 
#> $param[[1]]$description
#> [1] "a paper object or paperlist object"
#> 
#> 
#> $param[[2]]
#> $param[[2]]$name
#> [1] "..."
#> 
#> $param[[2]]$description
#> [1] "further arguments (not used)"
#> 
#> 
#> 
#> $returns
#> [1] "a list with table, summary, traffic light"
#> 
#> $examples
#> <rd> module_run(psychsci, "all_p_values")
#> $func_name
#> [1] "all_p_values"
#>