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

Closes #58 fixed appendix #152

Merged
merged 18 commits into from
May 2, 2024

Conversation

StefanThoma
Copy link
Collaborator

@StefanThoma StefanThoma commented Apr 25, 2024

Thank you for your Pull Request! We have developed this task checklist to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your blog post.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the main branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update), and make sure the corresponding issue is linked in the Development section on the right hand side
  • Run the script from CICD.R line by line to first check the spelling in your post and then to make sure your code is compatible with our code-style. Address any incongruences by following the instructions in the file!
  • Choose (possibly several) tag(s) or categories from the current list: c("Metadata", "SDTM", "ADaM", "TLG", "Shiny", "Community", "Conferences", "Submissions", "Technical") for your blog post. If you cannot find anything that fits your blog post, add your own tag! We occasionally tidy up all tags for consistency.
  • Add a short description for your blog post in the description field at the top of the markdown document.
  • Blog post is short, personalized, reproducible and readable
  • Add a disclaimer at the top of your post, if appropriate (example: Disclaimer
    This blog contains opinions that are of the authors alone and do not necessarily reflect the strategy of their respective organizations.)
  • Address all merge conflicts and resolve appropriately
  • Assign two of us (@bms63, @manciniedoardo, @StefanThoma, @kaz462) as reviewers in the PR.
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

@StefanThoma StefanThoma linked an issue Apr 25, 2024 that may be closed by this pull request
@StefanThoma StefanThoma requested a review from bms63 April 25, 2024 07:55
@StefanThoma
Copy link
Collaborator Author

Still in draft, and was not able to re-knit everything, and only did it for one example so far.
What do you think of this, @bms63?
The source link should take you now to the .qmd file responsible for the post, and the R environment should now take you to a .txt file on github that is automatically created and captures sessionInfo().

@StefanThoma
Copy link
Collaborator Author

Should we reconsider whether we want renv.lock files?

Copy link
Collaborator

@bms63 bms63 left a comment

Choose a reason for hiding this comment

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

When the Quarto Publish job publishes it takes the latest CRAN package. Will this get updated when that is run?

@StefanThoma
Copy link
Collaborator Author

When the Quarto Publish job publishes it takes the latest CRAN package. Will this get updated when that is run?

AFAIK it will get updated whenever the qmd is rendered.

insert_appendix <- function(repo_spec, name, collection = "posts", file_name) {
# write session info to txt
session_info <- sessionInfo()
writeLines(capture.output(session_info), con = "session_info.txt")
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Make sure this overwrites!

@bms63
Copy link
Collaborator

bms63 commented Apr 25, 2024

Cool!! Can you fix the actions and then we can merge in and see what it does!?!

@StefanThoma
Copy link
Collaborator Author

  • add note about this to readme
  • fix also other appendices
  • fix template
  • update quarto publisher?

@StefanThoma
Copy link
Collaborator Author

@bms63 I added a site to the blog including the session info.
That way we don't need to transfer information from the gh-pages branch to main, but it is rendered nonetheless.

Please feel free to render and check out the floating point post, thats where I adjusted the appendix function so far.

Copy link
Collaborator

@bms63 bms63 left a comment

Choose a reason for hiding this comment

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

So in the ci job this will update the packages in each blog post as well as provide a global session info page?

@bms63
Copy link
Collaborator

bms63 commented Apr 30, 2024

I had a chance to render the site locally - looks good.

Can you make a note of this process in the Readme and add a note for the reviewer to verify that this is in the blog post folder.

I don't really want to make this update across all the posts, unless you want to do it. I only want to do this going forward. Choose your adventure! :) Thanks again.

@StefanThoma
Copy link
Collaborator Author

Hi @bms63 can we merge this into main so I can be sure that all the links work fine on the main branch?
Only then would I like to update the template (I'd also update previous posts, I think)

@StefanThoma StefanThoma mentioned this pull request May 2, 2024
@StefanThoma
Copy link
Collaborator Author

@bms63 not sure why this link does not work:
https://rconsortium.shinyapps.io/submissions-pilot2/

Copy link
Collaborator

@bms63 bms63 left a comment

Choose a reason for hiding this comment

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

I like the reference to the session info - smart!

Why do we need the roxygen package?

As an admin you can just bypass normal PR stuff if you are experimenting. Just don't leave the site broken!!

@StefanThoma StefanThoma merged commit eb10dcf into main May 2, 2024
3 of 4 checks passed
@StefanThoma StefanThoma deleted the 58-source-code-and-how-it-works-with-appendixr branch May 2, 2024 13:38
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.

Source Code and how it works with appendix.R
2 participants