Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix references #6

Open
krpaulson opened this issue Mar 20, 2020 · 2 comments
Open

Fix references #6

krpaulson opened this issue Mar 20, 2020 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@krpaulson
Copy link
Collaborator

So far, I tried using this as a guideline: https://cran.r-project.org/web/packages/Rdpack/vignettes/Inserting_bibtex_references.pdf

The steps I took were:
(1) Add to DESCRIPTION
Imports: Rdpack
RdMacros: Rdpack
(2) Add to globals file to add to NAMESPACE:
#' @importFrom Rdpack reprompt
(3) Create inst/REFERENCES.bib file with sample references in .bib format
(4) Add to @references section in roxygen headers:
\insertRef{key}{lifetableUtils}

When I did this the references did not render correctly. Need to revisit this.

@krpaulson
Copy link
Collaborator Author

From @spencerpease : "If getting in-documentation citations to work is difficult, maybe we could make a citations() function or vignette that just lists these citations (and maybe how to cite this package if someone (hopefully) wanted to use it)."

@krpaulson krpaulson added the documentation Improvements or additions to documentation label Mar 26, 2020
@spencerpease
Copy link
Member

I just came across some information on using citations in R Markdown documents in the RStudio cheatsheet, on the second page. It might help with at least adding citations to the vignettes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants