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

Provide example .xlsx file as a guide #133

Open
3 tasks done
jacobcook1995 opened this issue Apr 25, 2024 · 1 comment
Open
3 tasks done

Provide example .xlsx file as a guide #133

jacobcook1995 opened this issue Apr 25, 2024 · 1 comment
Assignees

Comments

@jacobcook1995
Copy link
Collaborator

jacobcook1995 commented Apr 25, 2024

At the moment, we only provide an empty template file in the documentation. This file is only provided in the data providers section of the documentation, when it really should be provided to data managers as well. The link to this file is also currently broken.

Beyond this it would be useful to include a populated example file, as some of the worksheets (particularly the data worksheet) are not intuitive to populate. This could be generated based on the examples currently given in the documentation.

We need to:

  • Fix the broken template link
  • Make sure that the template is linked in the data manager docs as well.
  • Create an example file with populated data and include it the docs
@jacobcook1995
Copy link
Collaborator Author

jacobcook1995 commented May 17, 2024

The PR above partly addresses the above however the following changes need to be made before this issue can be closed.

  • File download link should point to develop (once PR is merged there)
  • File download link should point to main (once the release branch is merged)
  • Code in Summary.md should be simplified (once headers=False issue is fixed)

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

No branches or pull requests

1 participant