[R-pkg-devel] Question on Description/Citing Feedback

[Ivan Krylov]

On Fri, 16 Dec 2022 10:06:44 -0800
Michael Topper <miketopper123 using gmail.com> wrote:

>    - I understand the Description portion of the DESCRIPTION file
> needs to be edited, but I'm a little confused as to what I am
> supposed to add and how. Do I need to include a citation to the
> published paper of modelsummary

Yes, exactly.

>       - Arel-Bundock, Vincent (2022). “modelsummary: Data and Model
>       Summaries in R.” Journal of Statistical Software, 103(1), 1-23.
>       doi:10.18637/jss.v103.i01
> https://doi.org/10.18637/jss.v103.i01.’

Translating that in the "authors (year) <doi:...>" format, we get:

  Arel-Bundock, V. (2022) <doi:10.18637/jss.v103.i01>

Use this form to reference the paper in the Description: field of your
DESCRIPTION.

> What would be most helpful:
> 
>    - If there is any other Description file from another package that
>    contains an example of what to do in such a situation, this would
> be greatly appreciated!

My own package received the same feedback on initial submission as
yours, so here's what I did: https://CRAN.R-project.org/package=cmocean

When you include documentation from a different package into one of your
own, mentioning the documentation authors in the Authors using R: field is
the right thing to do. If you want to be 100% sure, check whether parts
of documentation you're including could have been authored by other
people mentioned as contributors to modelsummary.

Hope this helps!

> 	[[alternative HTML version deleted]]

Here's how we see your e-mail:
https://stat.ethz.ch/pipermail/r-package-devel/2022q4/008746.html

Unfortunately, when you compose your messages in HTML, we only get the
plain text version automatically generated by your mailer, which may be
not a perfect representation of your message. Composing your messages to
R-package-devel in plain text will prevent them from being mangled.

-- 
Best regards,
Ivan