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 #242 #241

Merged
merged 8 commits into from
Oct 11, 2024
Merged

Closes #242 #241

merged 8 commits into from
Oct 11, 2024

Conversation

pawelru
Copy link
Collaborator

@pawelru pawelru commented Oct 3, 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
  • Ensure your new post folder is of the form "posts/zzz_DO_NOT_EDIT_<your post title>". This is so that the post date can be auto-updated upon the merge into main.
  • 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, propose a new tag to the maintainers! Note: if you use a tag not from this list, the "Check Post Tags" CICD pipeline will error. 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!

@pawelru
Copy link
Collaborator Author

pawelru commented Oct 3, 2024

Hmmm... It looks like the R/CICD.R does not complain but apparently CICD itself does. Do we use something else?

@pawelru pawelru linked an issue Oct 3, 2024 that may be closed by this pull request
@manciniedoardo
Copy link
Collaborator

@pawelru we are having some issues with the spellcheck action, please ignore if all fine on your end.

@pawelru
Copy link
Collaborator Author

pawelru commented Oct 9, 2024

Hello reviewers! Hope you are doing well! I wanted to follow up on this PR to see if you might have a chance to review it. Please let me know if there's anything I can do to help!

@StefanThoma
Copy link
Collaborator

StefanThoma commented Oct 9, 2024 via email

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.

Sorry @pawelru it looks good to me - ty for the poke. @StefanThoma can merge in once he finishes his review

Copy link
Collaborator

@manciniedoardo manciniedoardo left a comment

Choose a reason for hiding this comment

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

Thanks for the reminder, Pawel. A couple of small comments for me.

On a wider note, if you've got open issues for development, it might be good to explicitly encourage people to contribute? You could welcome comments in the issues or in the slack channels etc.

@pawelru
Copy link
Collaborator Author

pawelru commented Oct 10, 2024

Thanks all the good comments! Asking for another round of review 🕺

@manciniedoardo manciniedoardo self-requested a review October 10, 2024 08:24
Copy link
Collaborator

@manciniedoardo manciniedoardo left a comment

Choose a reason for hiding this comment

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

LGTM


PS2. I've been also thinking about a similar solution for non-Shiny R codes. See [this](https://github.com/r-lib/pkgdown/issues/2348) and [this](https://github.com/r-wasm/webr/issues/356) issues for more updates.

I’d love for you to try out `roxy.shinylive` and see how it can enhance your Shiny package development workflow. Whether you have feedback, suggestions, or feature requests, please feel free to file an issue on the https://github.com/insightsengineering/roxy.shinylive, or join our [`pharmaverse` Slack channel](https://pharmaverse.slack.com/) to stay up to date and be part of the discussion.
Copy link
Collaborator

Choose a reason for hiding this comment

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

It's really cool!
What would the placeholder for such an iframe be in the pdf version of the manual?
What does it look like when I look at the help page from the r console in rstudio, i.e. using ?function

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

For pdf it would be just an empty space. It's in the docs here. If you are curious about implementation -> here

In the R console you can do the following:
? roxy.shinylive::create_shinylive_url -> it would open a manual of create_shinylive_url() which is also here
One can also do help("tag-examplesShinylive") to see this. I don't know how to open the latter via ? - that's why I encouraged the use of pkgdown help throughout the article.

I think I don't want to mention that here not to make it too detailed or become a technical writing. That's just to pitch an idea if you know what I mean

Copy link
Collaborator

@StefanThoma StefanThoma left a comment

Choose a reason for hiding this comment

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

Would be cool if you could answer the two questions in the post, otherwise cool package & post! :)

@pawelru pawelru requested a review from StefanThoma October 11, 2024 08:27
@StefanThoma
Copy link
Collaborator

CICD spell check worked on my side, I've added some words.

LGTM!

@manciniedoardo manciniedoardo merged commit 8e2766c into main Oct 11, 2024
5 checks passed
@manciniedoardo manciniedoardo deleted the roxy_shinylive_post branch October 11, 2024 12:34
@manciniedoardo
Copy link
Collaborator

@pawelru all merged - please feel free to publicise your post as you see fit and we will re-share 😄

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.

Blog Post: a new roxy.shinylive
4 participants