search

TommyJones / tidylda

Implements an algorithim for Latent Dirichlet Allocation using style conventions from the [tidyverse](https://style.tidyverse.org/) and [tidymodels](https://tidymodels.github.io/model-implementation-principles/index.html).
Other
41 stars 3 forks source link

JOSS Review: Minor documentation updates #74

Open hassaniazi opened 1 week ago

hassaniazi commented 1 week ago

Hi, great job on developing this package. I will post detailed comments on the paper later. For now, I have two minor requests:

  1. There are two License files in the repo at the moment. Can you merge those into one. I believe you can modify the MIT license.
  2. JoSS wants your documentation of the package to also include some things that you have mentioned in the paper. I think you have mentioned most of it already in the package documentation as well but can you please make sure using the Documentation section of this checklist: https://github.com/openjournals/joss-reviews/issues/6800#issuecomment-2183637317. You may port some text from the paper.
TommyJones commented 5 days ago

Hi. Thanks for reviewing.

RE the first issue, we discussed this as part of #72. The TLDR is that the current license structure in the package is consistent with the recommended approach for R packages. It's not ideal, I know, but it's an artifact of CRAN policies.

For the second issue, I'm seeing that I don't have community guidelines but the rest is there. Does that reflect what you are asking for?

TommyJones commented 4 days ago

Added contribution guideline and code of conduct here: 1db7a975957d390ba2f3ce96c5f2882564aace26

I'll close this issue upon confirmation that this was the only documentation issue or when I know what other issues need addressing.