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

Add cohorts submissions guide #193

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

jas-mckin
Copy link
Contributor

-fixes links and updates pathgoens submissions guide

  • adds cohorts submissiosn guide

add cohort-subs-guide.rst
updates to pathogen-subs-guide.rst
-updates new link to pathogen portal
-improves wording and fixes typos
fixes link to bash script example
@jas-mckin jas-mckin requested a review from z-w123 July 3, 2024 14:57
@jas-mckin jas-mckin marked this pull request as ready for review July 3, 2024 14:59
@jas-mckin jas-mckin marked this pull request as draft July 3, 2024 15:22
Comment on lines 63 to 78
2. Create the child Samples in additional database resources
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

The next step is to create your datasets in the correct database for the data type. The `EBI submissions wizard
<https://www.ebi.ac.uk/submission/>`_ can help direct you to a resource to deposit your data.
We can reccommend the following database resources for common data types:

- For sensitive human nucleotide records and human clinical epidemiological data which requires controlled access, please
contact the `EGA (European Genome Phenome Archive) <https://ega-archive.org/>`_ to start a submission.
- For expression data, or uncategorsied datasets, please use `ArrayExpress/BioStudies <https://www.ebi.ac.uk/biostudies/arrayexpress>`_

After the datasets have been submitted in the appropriate databases, the required child Samples for linking can be created.
The child samples will represent their relationship to the top-level Sample. Different samples can be used for different
data types **and** for different time points. Please contact us if you have any doubts about setting up your sample structure.


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would split this out into 2 sections for clarity - e.g.:
2. Submit other data types to appropriate database resources
3. Create the child samples for linking

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

step 2 is now split into steps 3 and 4

Comment on lines 93 to 94
For example, in the first linked dataset, the `EMC study <https://www.ebi.ac.uk/about/news/updates-from-data-resources/pathogens-portal-linked-dataset/>`_,
the BioSamples relationship is as follows:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would also be helpful to include a link here to the IDTK page, as it contains more diagrams: https://www.infectious-diseases-toolkit.org/showcase/linked-cohort-data

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IDTK added with link title '[Erasmus Medical Cemter (EMC) study'

Comment on lines 123 to 124
There is also a `python script<https://www.ebi.ac.uk/biosamples/docs/references/api/submit#_submit_curation_object>`_
which can be used to create the sample relationships. Please contact ena-path-collabs@ebi.ac.uk for technical support
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see you have not linked the python script here, but I was wondering if we can hold off on sharing that just yet anyway - as it's only really been tested on one use-case.
We have another 2 linking use-cases coming up that I am actively working on, so would like to test the script on at least one of those before sharing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this section has been removed

Copy link
Contributor

@z-w123 z-w123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Jasmine, I have added a few comments, if you could please take a look that would be great

- add sample structure image
- updates to doc structure
@jas-mckin jas-mckin marked this pull request as ready for review September 26, 2024 12:43
fix Biosamples curation link
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

Successfully merging this pull request may close these issues.

2 participants