AlexsLemonade / AlexsLemonade/OpenScPCA-analysis

Docs request: Organizing your module results

Open
#502 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
HTML
Stars
16
Forks
24
Avg merge
3d 5h
Merged PRs (30d)
4

Description

### What is the documentation improvement or update you wish to see?

We should add recommendations about how contributors might consider structuring their results output. The reason for this is because of how we anticipate to port modules over to `OpenScPCA-nf`, and associated use of the `download-results.py` script which has the ability to take `projects` and `samples` arguments. This would likely be a new doc added somewhere in the analysis modules section.

In parallel to explaining this results file structure, we should document the `projects` and `samples` arguments in the results download script. This should be added directly to those existing docs (forthcoming in #428, but will exist once we're ready to tackle this issue).

### Is there any additional context you would like to provide?

-

### If this request is for an existing documentation page, please provide the link here.

-

Contributor guide

Open the contributing guide

Research direction

Review the analysis modules documentation and the documentation for download-results.py after the work in #428 is available. Document recommended projects and samples result structure, then add the script's projects and samples arguments to its existing documentation; the issue is done when both documentation areas explain the expected layout and arguments.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.