philips-software / latrend

An R package for clustering longitudinal datasets in a standardized way, providing interfaces to various R packages for longitudinal clustering, and facilitating the rapid implementation and evaluation of new methods
https://philips-software.github.io/latrend/
GNU General Public License v2.0
28 stars 5 forks source link

Encourage users to cite underlying package when using a package-dependent method #110

Closed niekdt closed 10 months ago

niekdt commented 2 years ago

When users use a method that depends on an external cluster package, we would like to see them cite not just the latrend package, but also, and especially, the underlying package (e.g., kml).

Although each of the package-dependent methods have proper citations in the documentation, I think a more active approach is needed to convey to the user that they are using an underlying package.

Proposal: When a package-dependent method is used with latrend(), output a message with the citation instructions. This message can be disabled through a package-specific option, such as options(latrend.cite.kml = FALSE).