[R-pkg-devel] Including references in the DESCRIPTION file
Eugenio, the CRAN submission checklist available at https://cran.r-project.org/web/packages/submission_checklist.html contains some information on how to write a suitable Description entry in the DESCRIPTION file for CRAN packages. This contains: o Make the Description as informative as possible for potential new users of your package. If in doubt, make the Description longer rather than shorter, but try to avoid redundancies such as repetitions of the package name. as well as o Relevant citations should be included in the description. These should be in author-year style, preferably followed by an identifier such as DOI, arXiv id, or ISBN for published materials. Best, Bettina
On 4/29/21 3:45 PM, Eugenio L?pez Cortegano wrote:
Hi all, I have been asked by a CRAN member to add references for methods used in the package, in the description file of DESCRIPTION. The format to do so seems to be: authors (year) <doi...> authors (year) <arXiv:...> authors (year, ISBN:...) However, I feel a bit unconfident about how to properly include these changes, since I haven't find any other examples providing this information in DESCRIPTION, and what I have read in 'Writing R extensions' is that the Description field should be just one paragraph. Including these references at the end of that field seems to break that rule to me. Does anyone have experience with this or could provide a little more advice about how to implement these changes? Thank you, Eugenio [[alternative HTML version deleted]]
______________________________________________ R-package-devel at r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-package-devel