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

Documentation of package components #6

Open
diyadas opened this issue May 16, 2019 · 1 comment
Open

Documentation of package components #6

diyadas opened this issue May 16, 2019 · 1 comment

Comments

@diyadas
Copy link

diyadas commented May 16, 2019

As per openjournals/joss-reviews#1321

Largely excellent, just a few missing pieces.

  • moco: description is incomplete
  • unclear from documentation how to use coph.tocher, cophenetic.tocher, D2.disc.default, plot.genecovtest, plot.singh, predict.D2.disc, print.gencovtest, print.tocher, singh.default, tocher.dist (listed in package contents, but unclear if meant to be called directly)
  • Most of the example code for sHe is commented out?
@arsilva87
Copy link
Owner

@diyadas

  • description updated
  • all those functions are S3 methods or alias for the functions that are directly called (print, plot...)
  • Most of the code was set not to run on tests, as they are time demanding.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants