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

[User feedback] Provide more clear guidance on installation in Readme #668

Closed
22 tasks
Assignees
Labels

Comments

@kumamiao
Copy link
Contributor

kumamiao commented Jun 10, 2022


@wangh107

By directly following the installation in the Readme page, installing teal would give the following error:
ERROR: dependencies ‘teal.data’, ‘teal.logger’, ‘teal.widgets’ are not available for package ‘teal.slice’

This issue: it would be good to add some notes about dependencies like in teal.slice Readme

For future, wondering if we could start to think if users could install nest as a whole like tidyverse

@kumamiao kumamiao added the core label Jun 10, 2022
@nikolas-burkoff
Copy link
Contributor

nikolas-burkoff commented Jun 23, 2022

We could add in:

You might need to manually install all of the package dependencies before installing this package as without the dependencies = FALSE argument to install_github it may produce an error.

As this is shown in (hopefully) all the other repos with NEST dependencies

Or we could use this issue to sort out the easiest way to install packages... @kumamiao @dinakar29

@kpagacz
Copy link
Contributor

kpagacz commented Jun 23, 2022

I see our READMEs suggest this:
image

The problem here is dependencies = FALSE (thankfully missing from the teal README). For now, as we do not have any public repository for our packages that causes these problems.

@dinakar29 is working asap to put our packages somewhere public. Depending on how long it takes, we might want to think about changing the DESCRIPTION files to point to our public github repos as a dependency so users can get a working installation.

@gogonzo
Copy link
Contributor

gogonzo commented Jun 30, 2022

Please check if including Remotes information in the description can help also. Please use remotes instead of devtools

@cicdguy
Copy link
Contributor

cicdguy commented Jun 30, 2022

Adding Remotes will help publish to https://pharmaverse.r-universe.dev/ui#packages
This can host the most recent version of packages. Packages are built every 60 minutes and published there.

@cicdguy
Copy link
Contributor

cicdguy commented Jun 30, 2022

We also had a discussion today, as a long term goal, to publish all public Github NEST packages to CRAN. More on that soon.
June release is available here publicly: https://github.com/insightsengineering/depository, but not a sustainable solution.

@nikolas-burkoff nikolas-burkoff self-assigned this Jul 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
6 participants