Yesterday, I somewhat hastily released version 0.8.6., to get the code out and to release some mental load due to too many Git branches. I think it has all the code that it should have, but the documentation is slightly lacking, for example:
[x] The "Details" of ?anticlustering do not explain the new argument cannot_link (at least I included an example). It should also be explained how the graph coloring ILP solver is selected (because it cannot be chosen by the user in this interface).
[x] anticlustering() does not at all refer to the new objective = "average-diversity" (it is only referred to in the change log in NEWS.md)
[ ] The new arguments in bicriterion_anticlustering() also require more explanation in the documentation.
[x] The DESCRIPTION is no longer technichally correct regarding the system requirements of the GLPK or Symphony, because anticlust now depends on lpSolve, which does not have any system requirements, because it includes the C source code of the lpsolve library. This should be reflected in the DESCRCIPTION.
I will extend this list when I become aware of additional omissions.
One reason for the lack of documentation is that I am currently working on a preprint that explains a lot of the changes in version 0.8.6 in more detail and on a "theoretical" level (especially regarding cannot-link constraints, but also the average diversity objective). However, I wanted to get the code out »now«, and I am not sure if / when I can finish the paper during summer. I should also insert a new vignette on anticlustering with cannot-link constraints then (because there are several ways to do it).
Yesterday, I somewhat hastily released version 0.8.6., to get the code out and to release some mental load due to too many Git branches. I think it has all the code that it should have, but the documentation is slightly lacking, for example:
?anticlustering
do not explain the new argumentcannot_link
(at least I included an example). It should also be explained how the graph coloring ILP solver is selected (because it cannot be chosen by the user in this interface).anticlustering()
does not at all refer to the newobjective = "average-diversity"
(it is only referred to in the change log in NEWS.md)bicriterion_anticlustering()
also require more explanation in the documentation.I will extend this list when I become aware of additional omissions.
One reason for the lack of documentation is that I am currently working on a preprint that explains a lot of the changes in version 0.8.6 in more detail and on a "theoretical" level (especially regarding cannot-link constraints, but also the average diversity objective). However, I wanted to get the code out »now«, and I am not sure if / when I can finish the paper during summer. I should also insert a new vignette on anticlustering with cannot-link constraints then (because there are several ways to do it).