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."
#> 
#> $author
#> [1] "Lisa DeBruine"
#> 
#> $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"
#>