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 figure to title page? #73

Open
iantaylor-NOAA opened this issue Jan 5, 2023 · 5 comments
Open

add figure to title page? #73

iantaylor-NOAA opened this issue Jan 5, 2023 · 5 comments
Assignees
Labels
type --- documentation improvements or additions to documentation type --- feature feature requests and enhancement

Comments

@iantaylor-NOAA
Copy link
Contributor

Problem

Before {sa4ss} PFMC assessment reports typically had an image of the species being assessed on the title page which looked nice and also helped when quickly switching among multiple reports.

I added a figure using the following approach:
https://github.com/pfmc-assessments/petrale/blob/main/documents/00title.Rmd
but that caused the figure to also appear in the citation and in between the ToC and the Exec Summary (see screenshot of first two pages below).

Proposal

Develop a method to add a figure to the title page (or document an existing approach).

This is obviously a low priority.

image

@iantaylor-NOAA iantaylor-NOAA added type --- documentation improvements or additions to documentation type --- feature feature requests and enhancement labels Jan 5, 2023
@kellijohnson-NOAA
Copy link
Contributor

@iantaylor-NOAA thanks for the suggestion. Once hake is over I will look. I think that it won't be too hard to add to the template, users would just need to save the figure a certain name and then I will look if a figure is available and bring it in.

@iantaylor-NOAA
Copy link
Contributor Author

That solution sounds perfect. Thank you.

kellijohnson-NOAA added a commit that referenced this issue Apr 5, 2023
@iantaylor-NOAA thanks for the suggestion. You can now include a figure
on the title page as long as you include it as figure_title.png in your
directory that stores all of the .Rmd files.

Part of #73 ... still need to add instructions on the readme or
somewhere else regarding how to do this because the functionality is
quite hidden.
@kellijohnson-NOAA
Copy link
Contributor

@iantaylor-NOAA feel free to reopen this issue if the instructions on the README do not work for you. You won't have to change any of your .Rmd files. Just reinstall {sa4ss}, change the saved name of your figure and place it in the proper directory, and compile via bookdown::render_book() and it should work.

@iantaylor-NOAA
Copy link
Contributor Author

Worked perfectly, thank you @kellijohnson-NOAA!

@kellijohnson-NOAA kellijohnson-NOAA removed the status --- wip work in progress label Jul 6, 2023
@iantaylor-NOAA
Copy link
Contributor Author

Two low priority additions to this issue:

  • it might be nice to provide alt-text for a title-page figure (other than "figure_title.png"),
  • it could also be good to have a place to provide photo credits if figure_title.png is a photo (typically we use images in the public domain, but still good to provide credit, perhaps right before or after the "Please cite this publication as..." section on the following page).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type --- documentation improvements or additions to documentation type --- feature feature requests and enhancement
Projects
None yet
Development

No branches or pull requests

2 participants