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

Documentation clarification: {renv} is not required to be used by the shiny developer #84

Closed
daattali opened this issue Jun 3, 2024 · 2 comments · Fixed by #100
Closed
Assignees
Milestone

Comments

@daattali
Copy link

daattali commented Jun 3, 2024

In the README, the section after "Usage" is "R package availability". It says that {shinylive} will inspect which packages are used via {renv}, and what to do if {renv} cannot find a package.

Perhaps this is a non-issue for others, but I interpreted it to mean that {shinylive} expects my shiny app to be using {renv}. I was surprised when an export() worked without me explicitly using {renv}, and only after reading the README a few times I understood that
{shinylive} is automatically using {rnev} internally.

If you think the issue is me having to improve my reading comprehension then you can close this issue!

@gadenbuie
Copy link
Contributor

The quote is:

The shinylive web assets will statically inspect which packages are being used via renv.

I can see how the confusion would arise. I think we could either include a sentence noting that your project does not need to have an renv.lock and that we're using renv only for package discovery.

On the other hand, I think that sentence and the entire section would be even less confusing if we didn't mention renv at all and just said that "shinylive will automatically discover which packages are used in your application".

@gadenbuie gadenbuie added this to the v0.2.0 milestone Jun 26, 2024
@daattali
Copy link
Author

I agree with removing the mention of renv entirely.

@gadenbuie gadenbuie self-assigned this Jul 1, 2024
gadenbuie added a commit that referenced this issue Jul 1, 2024
It can be confusing (does the app need to use renv?) and it's an internal implementation detail
that isn't broadly useful to users.

Fixes #84
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 a pull request may close this issue.

2 participants