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

Add citation file for Cite link in template #19

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

avallecam
Copy link
Member

@avallecam avallecam commented Nov 15, 2023

Fix #18

The aim is to generate a file linkable from the Cite in the footer of the rendered URL.

Feedback is welcome to evaluate having more than one citation file, or whether to remove some of them out of version control.

this complements the cff file and the inst/citation file
Copy link

github-actions bot commented Nov 15, 2023

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/epiverse-trace/research-compendium/compare/md-outputs..md-outputs-PR-19

The following changes were observed in the rendered markdown documents:


What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2023-11-15 18:54:32 +0000

@avallecam avallecam changed the title fix #18 add citation file for template Add citation file for template for Cite link in template Nov 15, 2023
github-actions bot pushed a commit that referenced this pull request Nov 15, 2023
@avallecam avallecam changed the title Add citation file for template for Cite link in template Add citation file for Cite link in template Nov 15, 2023
github-actions bot pushed a commit that referenced this pull request Nov 15, 2023
@avallecam avallecam marked this pull request as draft November 15, 2023 19:11
@avallecam avallecam marked this pull request as ready for review November 15, 2023 19:17
@avallecam
Copy link
Member Author

Hi @jamesmbaazam I identified a conflict between the generated CITATION.cff file for this repo and the expected CITATION file in the workbench template. I generated a solution that involves having both in the root folder. More details are in the associated issue.

Would you be able to review this and share your feedback about the solution proposed in this PR? and evaluate if it is a fair solution to propagate for other workbench repos in the organization?

@avallecam
Copy link
Member Author

Hi @jamesmbaazam do you think would be appropriate to have two citation files in the root folder?

  • CITATION.cff suitable for GitHub .cff feature to generate bibtex and apa formats (generated from DESCRIPTION file)
  • CITATION suitable for workbench template in a human-readable format (generated from CITATION.cff file)

I think that for the moment this can work.

But I can also consider reporting this to {varnish} to redirect to CITATION.cff when available

@jamesmbaazam
Copy link
Member

Hi @avallecam, I think it's fine. We do this in the packages as well but we also use the cff workflow to sync the .cff file with the DESCRIPTION and CITATION files. I think since this is not a package, you can probably delete Line 12 in the workflow.

@avallecam
Copy link
Member Author

We do this in the packages as well but we also use the cff workflow to sync the .cff file with the DESCRIPTION and CITATION files

This is informative. Thank you for sharing that workflow. I'll try to add it. This repo generates CITATION file from the DESCRIPTION file, so this should work as expected as in packages.

@jamesmbaazam
Copy link
Member

Oh yes, sorry, I didn't see the DESCRIPTION file when I quickly checked yesterday. You don't need to change anything then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

fix the Cite link in URL footer
2 participants