#47 standardize citations

[gemini-wenb]

Closes #47

This PR standardizes citation styles for references section in function documentation.

Notes:

Not all functions require a references section. To introduce some general structure to function documentation. The references section should typically be used when users are encouraged to include function-specific citations to their publications.

• Many functions contain links to extra resources in various sections (e.g. description, details). These resources are mostly links to data dictionary or CIHI documents. These resources may be regarded as general knowledge and specific citation may not be necessary (citing Rgemini would be sufficient).
• Certain functions, especially derived scores, were developed based on journal publications which necessitate citations upon use.
• For example, frailty_score() is developed based on a development paper, thereby, a citation is needed and it is included to the references section. Whereas, icd_to_ccsr() contains links to CIHI documentation of diagnosis definitions in function description, and these links don't need to be repeated in the reference section as they are not required citations.

Standard formatting style (aim to be simple):

• Journal articles: 1st_author_last_name initial, et al. Journal Abbrev, Year. https://doi.org/xxxx (written out, no hyperlink, should use doi url instead of others like pubmed url).
• Online doc: [description] (hyperlink)

[gemini-wenb]

This looks good to me. Built the documentation and checked the rendered help pages. Do we want to add our new citation/reference standards/requirements to CONTRIBUTING.md?

Also just confirming that we don't want to create hyperlinks to the DOI addresses in the roxygen?:

Thanks for reviewing @vaakesan-SMH! Great idea to add the reference standard to the CONTRIBUTING.md - should we do this for this sprint or add this as a backlog issue? For not making DOI addresses into links, I tend to see the References section as the References list in journal publications, thus by not making DOI into links (which hides the actual DOI address) but showing them as they are makes the items similar to how actual citations would look like; this also distinguishes journal articles from online website resources - open to other ideas :)

[vaakesan-SMH]

Happy to leave the DOI addresses as-is.

Lets update the CONTRIBUTING.md in this merge request.

[gemini-wenb]

Happy to leave the DOI addresses as-is.

Lets update the CONTRIBUTING.md in this merge request.

Sounds good. Let me update that!

[vaakesan-SMH]

Looks good to me, thanks Bijun. Please go ahead and merge.

[gemini-wenb]

I've added a description of citation standard to CONTRIBUTING. I also added checking citation style to the Code review checklist. @vaakesan-SMH could you give it a quick check and if everything looks ok I'll merge the request.

[vaakesan-SMH]

I've added a description of citation standard to CONTRIBUTING. I also added checking citation style to the Code review checklist. @vaakesan-SMH could you give it a quick check and if everything looks ok I'll merge the request.

looks great!