mixOmics icon indicating copy to clipboard operation
mixOmics copied to clipboard

Enhancement for Issue #30/#34

Open Max-Bladen opened this issue 2 years ago • 1 comments

This pull request adds the verbose.call parameter to the following methods:

  • pca,
  • spca,
  • pls,
  • spls,
  • rcc,
  • block.pls,
  • block.plsda,
  • block.spls,
  • block.splsda,
  • mint.pca,
  • mint.pls,
  • mint.plsda,
  • mint.spls and
  • mint.splsda

When TRUE, this parameter allows for all the variable values input into the method to be accessed via the output object (object$call). Also updated the documentation to accompany all of this. If coverage decreases significantly, will add more tests to compensate.

Max-Bladen avatar Mar 29 '22 00:03 Max-Bladen

I believe this PR is ready for review @aljabadi. Just a few extra notes:

  • I haven't adjusted my implementation as I never received a response to this comment. If you want this adjusted at all, just let me know.
  • A quick summary as its a large set of commits. This PR includes:
    • Addition of the verbose.call parameter to all functions in the above list. This parameter adjusts the output $call component. If verbose.call = TRUE, then $call will contain the actual input values.
    • Addition of all relevant info to the documentation of each adjusted function.
    • Test file containing checks for usage of verbose.call. This is not permanent and will be replaced as part of PR #221. This is just here to ensure the coverage stays above the minimum.
  • Still open to discussion on adjusting how this works/the range of functions it's implemented for.

Max-Bladen avatar Aug 01 '22 00:08 Max-Bladen

Second set of commits on 14/12/2022 reflect initial set of commits, but replicated after the branch was rebased to master following PR #281.

Max-Bladen avatar Dec 13 '22 21:12 Max-Bladen