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: Add links to Colab into Rmd and README file #1

Open
woodthom2 opened this issue Oct 28, 2024 · 1 comment
Open

Documentation: Add links to Colab into Rmd and README file #1

woodthom2 opened this issue Oct 28, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@woodthom2
Copy link
Contributor

woodthom2 commented Oct 28, 2024

Users are not able to use R library as effectively as Python because documentation is incomplete.

from Discord (28 Oct 2024):

image

We can't just directly edit the README since it's generated from Rmd

There is a lot of info in the Python README which needs to be copied over:

  • R markdown notebook
  • Colab notebook
  • Links to tutorials

but we can't just copy and paste, you need to copy just the information that is relevant for R, adapting where necessary. Then ideally update the Rmd, run the process to generate the README, and update CRAN if possible.

@woodthom2 woodthom2 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 28, 2024
@woodthom2
Copy link
Contributor Author

In general we need to make the Rmd and README files more comprehensive.

@woodthom2 woodthom2 self-assigned this Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant