Skip to content

0.6.0

Latest

Choose a tag to compare

@igor-siciliani igor-siciliani released this 21 May 15:39
· 2 commits to main since this release

corrp 0.6.0

Dedicated version for the publication of the corrp package in the JOSS.

  • Add VignetteBuilder: knitr to DESCRIPTION
  • Add usefull error message for required parameters.
  • Fix C++ Astar method.
  • Run benchmarks, expand the paper to include statements on resource-intensive options, and incorporate an enhanced version of energy::dcorT.test. Also, change the data used in the paper.
  • Update paper:
    • Give a more detail explanation of ACCA algorithm.
    • Strenghted statement of need.
    • Make a map of correlation → R method.
    • Provide a brief remark on the symmetry of the correlation matrix.
  • Update README.md according with changes in the paper and functions.

Methods Added

  • Added method set_arguments: Assigns provided arguments from the args_list to the parent environment. If an argument is inside the arguments of the methods that calculate statistics, it assigns it on the parent environment, and removes the argument from the list.
  • Added method assert_required_argument: Ensures that a required argument is provided. If the argument is missing, it throws an error with a clear message.

Methods Altered

  • Altered messages and make *.args lists be able to alter arguments (p.value, comp, "alternative", "num.s", "rk") of methods: .corlm, .cramersvp, .dcorp, .corperp, .micorp, .uncorp, .corpps.
  • Update the .corpps method to support p-value testing (p-test), which is disabled by default due to its slow performance. When p-test is not performed, the isig value is set to NA. p-test can be run assigning an element ptest = TRUE to pps.args argument.

Documentation

  • Enhanced the documentation for corrp and corr_fun by including examples, refining the pair type section with additional details and references, and providing a more comprehensive explanation of the output format and its interpretation.
  • Improved the documentation for corr_rm by adding examples and providing a clearer explanation of the c parameter.
  • Improved the documentation for acca by adding examples and providing a more detailed explanation in the description.
  • Added examples of usage in the documentation for: acca, best_acca, corrp, corr_rm, corr_matrix, corr_fun, ptest, sil_acca.
  • Fix grammar and ensure package style cohesion.