codecheckers / codecheck

R package assistant for conducting a CODECHECK
MIT License
10 stars 3 forks source link

rename citation() #16

Closed sje30 closed 4 years ago

sje30 commented 4 years ago

Currently citation() generates a citation of the current codecheck certificate. the function name clashes though with base::citation() which should be left alone. (incidentally, citation("codecheck") is already half-usable.)

should we simply not export the function, and rely on codecheck:::citation() or rename the function to something like codecheck_cite_cert() or cite_certificate()? My preference would be option 3.

nuest commented 4 years ago

cite_certificate() sounds good!

codecheck_cite_cert() only if we start prepending codecheck_ to all functions. Or cdchck_. But I don't have a strong opinion on that.