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

Draft of results - portal overview #26

Merged
merged 11 commits into from
Feb 28, 2024

Conversation

allyhawkins
Copy link
Member

This PR includes a draft of the first section in the results. I mostly followed the outline that we had written.

  • Do we need more information about why it's helpful to have ontologies? Or is stating that we include them enough?
  • I definitely struggled with the description of additional modalities. Technically CITE and multiplexed data are additional sequencing done on the same library or collection of cells vs bulk and spatial which will be a different library. We break down libraries in the table, so I didn't want to gloss over it but I also didn't want to be too confusing?

Copy link
Member

@jaclyn-taroni jaclyn-taroni left a comment

Choose a reason for hiding this comment

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

Thanks for getting this started. Regarding the following:

I definitely struggled with the description of additional modalities. Technically CITE and multiplexed data are additional sequencing done on the same library or collection of cells vs bulk and spatial which will be a different library. We break down libraries in the table, so I didn't want to gloss over it but I also didn't want to be too confusing?

I recommend trying to take another pass at this when you're addressing the comments I'm returning about Figure 1B, and then I'll try to focus on that as part of my next review.

As mentioned in #46, most of my comments here are around Fig 1A-B, but I also think we should talk more about ontologies to answer your other question.

All samples on the Portal include a core set of metadata obtained from investigators, including age, sex, diagnosis, subdiagnosis (if applicable), tissue location, and disease stage.
Some investigators submitted additional metadata, such as treatment and tumor stage also found on the Portal.
All submitted metadata was standardized as much as possible to maintain consistency across projects before adding to the Portal.
In addition to providing a human-readable value for the submitted metadata, we also provide an ontology term ID, if applicable.
Copy link
Member

Choose a reason for hiding this comment

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

Do we need more information about why it's helpful to have ontologies? Or is stating that we include them enough?

Yes, and it would be helpful to specify which ontologies are used, too, in my opinion. You're underselling the value-add (not to mention the work that went into the metadata) the way this is currently written.

Copy link
Member

Choose a reason for hiding this comment

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

Reading the first methods PR reminded me that we should probably file an issue to track methods for the ontologies!

content/03.results.md Show resolved Hide resolved
However, some samples include additional data, such as quantified data from tagging cells with Antibody-derived tags (ADT), like CITE-seq[@doi:10.1038/nmeth.4380], or multiplexing samples with hashtag oligonucleotides (HTO)[@doi:10.1186/s13059-018-1603-1].
In some cases, multiple libraries from the same sample were collected to conduct either bulk RNA-seq or spatial transcriptomics.
Downloading a sample on the Portal will include sequencing data from all associated libraries, including data from any additional modalities mentioned here.
A summary of the number of samples with each additional modality is shown in Figure 1B, and a detailed summary of the total samples with each sequencing method broken-down by project, is available in Supplemental Table 1.
Copy link
Member

Choose a reason for hiding this comment

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

Similar to the comment above, how you're talking about the figure in the main text should add additional benefits for the audience, not just summarize the legend. For example, what proportion of samples in the Portal have an additional modality?

…lts-edits

Add JNT edits to overview section of results
@allyhawkins allyhawkins mentioned this pull request Feb 26, 2024
Copy link

Click the link below to download the manuscript build as a ZIP file.
This build is associated with commit 8a2b9f1.

Manuscript build

Copy link

Click the link below to download the manuscript build as a ZIP file.
This build is associated with commit 1d0f5e6.

Manuscript build

@allyhawkins
Copy link
Member Author

I made the following changes:

  • Added some more description about what ontology terms are included and why they are helpful.
  • Described the types of samples on the Portal in terms of diagnosis and disease timing.
  • Tweaked the additional modalities paragraph a little and included a summary of the proportion of samples that have each modality in the text.

You made this comment in #46:

I also think we could wait to talk about what downloads are available until Figure 3A, even though that doesn't show individual sample downloads.

Does this mean we should remove the project card information? What description of downloads are you specifically referring to?

@jaclyn-taroni this should be ready for another look.

Copy link

Click the link below to download the manuscript build as a ZIP file.
This build is associated with commit 01d558b.

Manuscript build

@jaclyn-taroni
Copy link
Member

You made this comment in #46:

I also think we could wait to talk about what downloads are available until Figure 3A, even though that doesn't show individual sample downloads.

Does this mean we should remove the project card information? What description of downloads are you specifically referring to?

I took the description of what downloads are available out: https://github.com/AlexsLemonade/ScPCA-manuscript/pull/46/files#diff-79bf22740443da98b87b364ef8ccd6495aa7c14b98b8e5354d7c38bd66e4af71L25

Copy link

Click the link below to download the manuscript build as a ZIP file.
This build is associated with commit a5eaf5a.

Manuscript build

Copy link
Member

@jaclyn-taroni jaclyn-taroni left a comment

Choose a reason for hiding this comment

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

I am returning two comments that need to be addressed in some form or another before merging, but I don't think I need to see this again.

Some investigators submitted additional metadata, such as treatment and tumor stage, which can also be found on the Portal.
All submitted metadata was standardized to maintain consistency across projects before adding to the Portal.
In addition to providing a human-readable value for the submitted metadata, we also provide an ontology term ID, if applicable.
We mapped submitted metadata for age, sex, organism, disease, tissue, and ethnicity (if applicable), to their associated ontology term IDs using the ontology lookup service.
Copy link
Member

Choose a reason for hiding this comment

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

This does not fully address my comment (https://github.com/AlexsLemonade/ScPCA-manuscript/pull/26/files#r1501617420):

Yes, and it would be helpful to specify which ontologies are used, too, in my opinion.

I meant the ontologies themselves. So, UBERON, MONDO, etc. If you want to add a TODO in an HTML comment and let others weigh in later, that would be fine. I expect that #50 would include this level of detail.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sorry, I wasn't sure how much detail to go into here vs. the methods regarding the names of the actual ontologies. I updated this to indicate both where the ontology comes from and what metadata they are used for in d76f191 if you want to take another look.

content/03.results.md Outdated Show resolved Hide resolved
Copy link

Click the link below to download the manuscript build as a ZIP file.
This build is associated with commit 73a6a73.

Manuscript build

Copy link

Click the link below to download the manuscript build as a ZIP file.
This build is associated with commit b99cf72.

Manuscript build

Copy link

Click the link below to download the manuscript build as a ZIP file.
This build is associated with commit d76f191.

Manuscript build

Some investigators submitted additional metadata, such as treatment and tumor stage, which can also be found on the Portal.
All submitted metadata was standardized to maintain consistency across projects before adding to the Portal.
In addition to providing a human-readable value for the submitted metadata, we also provide an ontology term ID, if applicable.
Submitted metadata was mapped to an associated ontology term IDs obtained from HsapDV (age), PATO (sex), NCBI taxonomy (organism), MONDO (disease), UBERON (tissue), and Hancestro (ethnicity, if applicable).
Copy link
Member

Choose a reason for hiding this comment

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

I'd add citations, but LGTM otherwise

Copy link

Click the link below to download the manuscript build as a ZIP file.
This build is associated with commit 93f6cce.

Manuscript build

Copy link

Click the link below to download the manuscript build as a ZIP file.
This build is associated with commit 03ac73c.

Manuscript build

@allyhawkins allyhawkins merged commit 629de31 into main Feb 28, 2024
1 check passed
@allyhawkins allyhawkins deleted the allyhawkins/draft-results-overview branch February 28, 2024 15:14
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