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

Fix/remove R example in docs #554

Open
alexdewar opened this issue Nov 4, 2024 · 0 comments
Open

Fix/remove R example in docs #554

alexdewar opened this issue Nov 4, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@alexdewar
Copy link
Contributor

alexdewar commented Nov 4, 2024

The "get started" page contains an example of how to process the output data using R.

There are a few issues with this:

  1. When I tried it, I just got an empty plot, so at the very least it needs fixing
  2. It uses the JSON output file, whereas we probably want users to use the CSV file instead
  3. It might have been superseded entirely by @SaranjeetKaur's R package

@SaranjeetKaur maybe you could have a quick look at this at some point? Only if you have time! Given that people can probably just use your R package instead, I think it would be totally fine to just signpost that and delete this content altogether.

Edit: I've just noticed there's also some R code in the user guide, but it might be removed as part of #555.

@alexdewar alexdewar added the documentation Improvements or additions to documentation label Nov 4, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Health-GPS Nov 4, 2024
@alexdewar alexdewar changed the title Fix/remove R example in docs/getstarted.md Fix/remove R example in docs Nov 4, 2024
@alexdewar alexdewar moved this from 📋 Backlog to 🔖 Ready in Health-GPS Nov 4, 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
Projects
Status: 🔖 Ready
Development

No branches or pull requests

1 participant