Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Benchmark #15

Open
wants to merge 28 commits into
base: JOSS
Choose a base branch
from
Open

Benchmark #15

wants to merge 28 commits into from

Conversation

PHS-Meantrix
Copy link
Contributor

@PHS-Meantrix PHS-Meantrix commented Nov 1, 2024

Description

0.6.0

  • 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.

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 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.
  • Added examples of usage in the documentation for: acca, best_acca, corrp, corr_rm, corr_matrix, corr_fun, ptest, sil_acca.

Make bench mark scripts
make full bench mark results
update paper with performance improvements
make statments of benchmark and choices
fix returned table put seed
@PHS-Meantrix PHS-Meantrix self-assigned this Nov 1, 2024
@PHS-Meantrix PHS-Meantrix marked this pull request as ready for review November 1, 2024 22:35
@PHS-Meantrix PHS-Meantrix linked an issue Nov 1, 2024 that may be closed by this pull request
@PHS-Meantrix PHS-Meantrix added the documentation Improvements or additions to documentation label Nov 1, 2024
update corrp documentation
update doc with example
make documentation update fix vignette on desc
export corrplot and update readme
update error message
update documentation
udpate documentation in corr_rm
correct documentation format
make ptest for pps
make assert_required_argument
make sys.call correct for assert_req_arg
fix assert when lazy eval
make ptest for pss optional
update documentation end
make more msg on the best_acca sil_acca and acca
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment