AlexsLemonade / scpca-downstream-analyses

This repository is intended to store our pipeline for marker genes analysis.
0 stars 0 forks source link

Add documentation on working with ScPCA portal data #326

Closed cbethell closed 1 year ago

cbethell commented 1 year ago

Issue Addressed Closes #313

What is the purpose of these changes?

Now that we have synced the workflows in this repo with what's on the ScPCA portal, it's a great time to incorporate documentation in this repo on using data downloaded from the portal with these workflows.

What changes did you make?

This PR adds additional-docs/working-with-scpca-portal-data.md to guide users on how to prepare their project metadata file when using data downloaded from the ScPCA portal. The main README and module README files are also updated here to link to the working-with-scpca-portal-data.md documentation.

Any comments, concerns, or questions important for reviewers

Checklist

Place an x in all boxes that you have completed.

cbethell commented 1 year ago

Thanks for the review @allyhawkins! I've restructured things a bit as suggested so let me know what you think now -- especially on the section mentioning the required input_data_dir and it's structure, and the section on running the workflow for the additional modules.

cbethell commented 1 year ago

I've implemented those last couple of changes you suggested @allyhawkins! Let me know what you think of the added wording.