Roxygen2 documentation

[evanbiederstedt]

Hi @YidaZhang0628

This is my normal spiel below:

It would be nice to get this on CRAN when the code is ready. The big impediment to this is always the roxygen2 documentation.

--- if a function is not exported, please use the tag #' @keywords internal. It's useful to know which functions are exported and which are not
--- if a function is exported, please document all fields. Please use the format #' @parameterName type Explanation here (default=xxx). It's very useful to know the data type in the rxoygen2 comments.
--- it will be useful for CRAN reviews if all exported functions have examples, but....that doesn't always happen. But let's try our best.

With this, the other steps will be much easier, and we can quickly get this on CRAN.

Once you're ready to publish the package, let me know. I'll help clean things up.

See related discussions e.g. here: kharchenkolab/numbat#1

Thanks, Evan

[YidaZhang0628]

Hi Evan, Thanks for the reminder. I will keep this in mind when I upload the code and we can come back to clean things up at the end. Best,Yida On Monday, June 13, 2022, 09:11:56 PM EDT, evanbiederstedt ***@***.***> wrote: Hi @YidaZhang0628 This is my normal spiel :) It would be nice to get this on CRAN when the code is ready. The big impediment to this is always the roxygen2 documentation.

…

--- if a function is not exported, please use the tag #' @Keywords internal. It's useful to know which functions are exported and which are not --- if a function is exported, please document all fields. Please use the format #' @parameterName type Explanation here (default=xxx). It's very useful to know the data type in the rxoygen2 comments. --- it will be useful for CRAN reviews if all exported functions have examples, but....that doesn't always happen. But let's try our best. With this, the other steps will be much easier, and we can quickly get this on CRAN. Once you're ready to publish the package, let me know. I'll help clean things up. See related discussions e.g. here: kharchenkolab/numbat#1 Thanks, Evan — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were assigned.Message ID: ***@***.***>

[evanbiederstedt]

This might still be relevant @YidaZhang0628

I try to put all packages on CRAN---it helps with their popularity and usage

If you do the documentation, I can help out with the rest

Best, Evan