Create an instructions sheet for the study doc

[hepcat72]

FEATURE REQUEST

Inspiration

Some of the sheets and columns of the study doc may be confusing to some researchers

Description

Create an instructions sheet that explains how to fill in the various sheets of the study doc. It should be the first sheet seen when the study doc is opened.

For now, just draft the sheet in an excel file and add it to the test data folder. Try and figure out how to best display the instructions for readability. Automatically adding it to the template will be a separate issue.

Alternatives

None

Dependencies

This issue cannot be started until the completion of the following issue(s)/ pull request(s):

• issue_number_1

• pull_request_1

Comment

None

---

ISSUE OWNER SECTION

Assumptions

1. List of assumptions that the code will not explicitly address/check
2. E.g. We will assume input is correct (explaining why there is no validation)

Limitations

1. A list of things this work will specifically not do
2. E.g. This feature will only handle the most frequent use case X

Affected Components

• change: File path or DB table ...
• add: Environment variable or server setting
• delete: External executable or cron job

Requirements

• [ ] 1. List of numbered conditions to be met for the feature
• [ ] 2. E.g. Every column/row must display a value, i.e. cannot be empty
• [ ] 3. Numbers for reference & checkboxes for progress tracking

DESIGN

Interface Change description

None provided

Code Change Description

None provided

Tests

• [ ] 1. A description of at least one test for each requirement above.
• [ ] 2. E.g. Test for req 2 that there's an exception when display value is ''
• [ ] 3. Numbers for reference & checkboxes for progress tracking

[mneinast]

Rob, would you like me to draft this? Perhaps after you have made whatever updates you might be planning to the study doc?

[hepcat72]

I was hoping someone might do it, so yes! There are some tweaks I plan to make. They're outlined in this comment in the section: Sequence column/sheet confusion issues:. There are a few other relevant changes planned, as mentioned in that comment, but most of it doesn't apply. You can skim it and see if there's anything that affects what you might write. One thing to call attention to is the automatic skipping of samples whose names contain "blank". Blank samples are not added to the Samples sheet, but if some other substring is used (e.g. bk), that sample will get incorrectly added to the Samples sheet. So the user would have to manually delete that row from that sheet.

[hepcat72]

Changed this to optional, since the submission flow implementation provides instructions, making this issue a bit redundant. If we want to ultimately require it, I propose moving it to phase 2. Otherwise, let me know and I'll change it back to required here.