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

added first draft of new FSC-specific citations #107

Merged
merged 2 commits into from
Dec 17, 2024

Conversation

sbreitbart-NOAA
Copy link
Collaborator

What is the feature?

How have you implemented the solution?

  • expanding if/else chunks that make office-specific citations

Does the PR impact any other area of the project, maybe another repo?

  • No

Copy link
Contributor

Instructions for code reviewer

Hello reviewer, thanks for taking the time to review this PR!

  • Please use this checklist during your review, checking off items that you have verified are complete!
  • For PRs that don't make changes to code (e.g., changes to README.md or Github actions workflows), feel free to skip over items on the checklist that are not relevant. Remember it is still important to do a thorough review.
  • Then, comment on the pull request with your review indicating where you have questions or changes need to be made before merging.
  • Remember to review every line of code you’ve been asked to review, look at the context, make sure you’re improving code health, and compliment developers on good things that they do.
  • PR reviews are a great way to learn, so feel free to share your tips and tricks. However, for optional changes (i.e., not required for merging), please include nit: (for nitpicking) before making the suggestion. For example, nit: I prefer using a data.frame() instead of a matrix because...
  • Engage with the developer when they respond to comments and check off additional boxes as they become complete so the PR can be merged in when all the tasks are fulfilled. Make it clear when this has been reached by commenting on the PR with something like This PR is now ready to be merged, no changes needed.

Checklist

  • The PR is requested to be merged into the appropriate branch (typically main)
  • The code is well-designed.
  • The functionality is good for the users of the code.
  • Any User Interface changes are sensible and look good.
  • The code isn’t more complex than it needs to be.
  • Code coverage remains high, indicating the new code is tested.
  • The developer used clear names for everything.
  • Comments are clear and useful, and mostly explain why instead of what.
  • Code is appropriately documented (doxygen and roxygen).

@sbreitbart-NOAA sbreitbart-NOAA marked this pull request as ready for review December 17, 2024 18:09
"Please cite this publication as: \n",
"\n",
author_list, ". ", title, ".", year,
". Prepared by [COMMITTEE]. [XX] p."
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if this can be automated...

"\n",
author_list, ". ", year, ". ",
title, ". NOAA Tech. Memo. [TECH MEMO NUMBER]",
", ", "[XX] p."
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above

title, ". ", off_title, ", ",
loc_city, ", ", loc_state, ". "
"SEDAR. ", year, ". ", title, ". ",
"SEDAR, North Charleston SC. [XX] pp. ",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

Copy link
Collaborator

@Schiano-NOAA Schiano-NOAA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me - I haven't test this. I am wondering if we can add code that would automate the number of pages (I feel like this should be possible)

@sbreitbart-NOAA
Copy link
Collaborator Author

This looks good to me - I haven't test this. I am wondering if we can add code that would automate the number of pages (I feel like this should be possible)

From a little googling, I'm not finding any quick fixes. I think it might be tricky. The workflow for calculating the page length might be: render to pdf with latex, then put the number back into the R script. I'm not sure R could accurately calculate page length before rendering. What if we added it as an issue for the future?

@Schiano-NOAA
Copy link
Collaborator

This looks good to me - I haven't test this. I am wondering if we can add code that would automate the number of pages (I feel like this should be possible)

From a little googling, I'm not finding any quick fixes. I think it might be tricky. The workflow for calculating the page length might be: render to pdf with latex, then put the number back into the R script. I'm not sure R could accurately calculate page length before rendering. What if we added it as an issue for the future?

@sbreitbart-NOAA That works! Maybe just something to think about as an added feature, but if we can't do it, we can't do it 🤷

@sbreitbart-NOAA sbreitbart-NOAA merged commit 58e5772 into dev-1.0 Dec 17, 2024
6 of 8 checks passed
@sbreitbart-NOAA sbreitbart-NOAA deleted the update-citations branch December 17, 2024 18:33
@kellijohnson-NOAA
Copy link
Collaborator

kellijohnson-NOAA commented Dec 17, 2024

You can use a call to latex within the template that puts in the number of page numbers on the second time that it is built.

\pageref{LastPage}{}

@sbreitbart-NOAA
Copy link
Collaborator Author

You can use a call to latex within the template that puts in the number of page numbers on the second time that it is built.

\pageref{LastPage}{}

Awesome, thanks Kelli!! We put this into a new issue #108 and will revisit after the first release.

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

Successfully merging this pull request may close these issues.

3 participants