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

Clarify statement of need in README #2

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

Clarify statement of need in README #2

diyadas opened this issue May 16, 2019 · 1 comment

Comments

@diyadas
Copy link

diyadas commented May 16, 2019

As per openjournals/joss-reviews#1321.

paper.md contains some information about what problems the software is designed to solve, but it's not obvious from the README. This paragraph answers the question:

There are several R packages for cluster analysis, with different outcomes and objective functions. However, none of them offers an implementation of the Tocher's algorithm. The R package biotools contains an implementation of Tocher's algorithms, the original and the modified or "sequential" algorithm [@vasconcelos07], as well as tools for evaluating the quality of clustering outcome. For this last part, biotools supplies some new and standard techniques such as: cophenetic() (for class tocher) - a specific cophenetic correlation coefficient [@silva13], boxM() - the Box's M-test for evaluating the equality of the cluster covariance matrices and D2.disc() - a discriminant analysis based on Mahalanobis distances. In addition, the function singh() can be used for determining the importance of variables based on the squared generalized Mahalanobis distance [@Singh81].

Please also specify who the target audience is in the README

@arsilva87
Copy link
Owner

@diyadas @labarba the README file was updated/improved.

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