Skip to content
This repository has been archived by the owner on Jun 21, 2023. It is now read-only.

Add docx output #302

Merged
merged 14 commits into from
Aug 11, 2022
Merged

Conversation

jashapiro
Copy link
Member

Purpose

Modified the github action to build the docx file as well as html and pdf outputs.

Issue

What GitHub issue does your pull request address?

#298

Directions for reviewers. Tell potential reviewers what kind of feedback you are soliciting.

In theory this should allow for a .docx output to appear in the output branch, and I would expect to see the same in the artifacts of the build.

Which areas should receive a particularly close look?

How does the output look?

Is there anything that you want to discuss further?

Is the pull request ready for review?

Let's see what happens with the first run.

and trailing spaces, apparently
@jashapiro
Copy link
Member Author

Looks like this works, mostly, though the frontmatter is kind of a mess (Word support for SVGs seems... lacking)

@AppVeyorBot
Copy link

AppVeyor build 1.0.921 for commit 7a5276f is now complete.

Found 0 potential spelling error(s). Preview:...
The rendered manuscript from this build is temporarily available for download at:

@AppVeyorBot
Copy link

AppVeyor build 1.0.923 for commit 1fa3e92 is now complete.

Found 0 potential spelling error(s). Preview:...
The rendered manuscript from this build is temporarily available for download at:

@AppVeyorBot
Copy link

AppVeyor build 1.0.925 for commit 52a46a0 is now complete.

Found 0 potential spelling error(s). Preview:...
The rendered manuscript from this build is temporarily available for download at:

@AppVeyorBot
Copy link

AppVeyor build 1.0.927 for commit e6a858a is now complete.

Found 0 potential spelling error(s). Preview:...
The rendered manuscript from this build is temporarily available for download at:

@jashapiro jashapiro marked this pull request as ready for review August 10, 2022 20:41
even if we aren't using them
@jashapiro
Copy link
Member Author

Marking this ready for review. I replaced the icon svgs with pngs, which solved the awful docx rendering, at the cost of slightly less pretty pdf & html output.

Otherwise, the docx rendering looks fine, and I added it to the appveyor script for one-click download of the docx version (e.g. #302 (comment)).

I believe that the github action update means the output branch will get the docx file on merge as well, but somebody might want to confirm that.

content/06.methods.md Outdated Show resolved Hide resolved
@AppVeyorBot
Copy link

AppVeyor build 1.0.930 for commit 64f6ac7 is now complete.

Found 0 potential spelling error(s). Preview:...
The rendered manuscript from this build is temporarily available for download at:

Copy link
Member Author

@jashapiro jashapiro left a comment

Choose a reason for hiding this comment

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

Noting below which lines in the methods are not just whitespace changes

@@ -292,7 +292,7 @@ Based on pediatric cancer literature review, we added _MYBL1_ [@doi:10.1073/pnas
#### Oncoprint figure generation (`oncoprint-landscape` analysis module)

We used `Maftools` [@doi:10.1101/gr.239244.118] to generate oncoprints depicting the frequencies of canonical somatic gene mutations, CNVs, and fusions for the top 20 genes mutated across primary tumors within broad histologies of the OpenPBTA dataset.
We collated canonical genes from the literature for low-grade astrocytic tumors [@doi:10.1186/s40478-020-00902-z], embryonal tumors [@doi:10.1038/nature22973; @doi:10.1007/s00401-020-02182-2; @doi:10.1186/s40478-020-00984-9; @doi:10.1016/j.ccell.2016.02.001; @doi:10.1038/s41598-020-59812-8], diffuse astrocytic and oligodendroglial tumors [@doi:10.1016/j.ccell.2017.08.017; @doi:10.1002/ijc.32258; @doi:10.1093/neuonc/noab106; @doi:10.1186/s40478-020-00905-w], and other tumors: ependymal tumors, craniopharyngiomas, neuronal-glial mixed tumors, histiocytic tumors, chordoma, meningioma, and choroid plexus tumors [@doi:10.1007/s00381-017-3481-3; @doi:10.1016/j.ccell.2015.04.002; @doi:10.1038/nature13109; @doi:10.1038/s41525-017-0014-7; @doi:10.3171/2019.8.JNS191266; @doi:10.1007/s00401-016-1539-z; @doi:10.1093/neuonc/noaa267; @doi:10.1016/s0002-9440(10)64477-x; @doi:10.1016/j.jaad.2017.05.059; @doi:10.1186/s40478-020-01056-8].
We collated canonical genes from the literature for low-grade astrocytic tumors [@doi:10.1186/s40478-020-00902-z], embryonal tumors [@doi:10.1038/nature22973; @doi:10.1007/s00401-020-02182-2; @doi:10.1186/s40478-020-00984-9; @doi:10.1016/j.ccell.2016.02.001; @doi:10.1038/s41598-020-59812-8], diffuse astrocytic and oligodendroglial tumors [@doi:10.1016/j.ccell.2017.08.017; @doi:10.1002/ijc.32258; @doi:10.1093/neuonc/noab106; @doi:10.1186/s40478-020-00905-w], and other tumors: ependymal tumors, craniopharyngiomas, neuronal-glial mixed tumors, histiocytic tumors, chordoma, meningioma, and choroid plexus tumors [@pmid:28623522; @doi:10.1016/j.ccell.2015.04.002; @doi:10.1038/nature13109; @doi:10.1038/s41525-017-0014-7; @doi:10.3171/2019.8.JNS191266; @doi:10.1007/s00401-016-1539-z; @doi:10.1093/neuonc/noaa267; @pmid:12466115; @doi:10.1016/j.jaad.2017.05.059; @doi:10.1186/s40478-020-01056-8].
Copy link
Member Author

Choose a reason for hiding this comment

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

Non-whitespace change

We predicted telomerase activity of tumor samples using the recently developed `EXTEND` method [@doi:https://doi.org/10.1101/2020.05.21.109249].
Briefly, `EXTEND` estimates telomerase activity based on the expression of a 13-gene signature.
We derived this signature by comparing telomerase-positive tumors and tumors with activated alternative lengthening of telomeres pathway, a group presumably negative of telomerase activity.
We predicted telomerase activity of tumor samples using the recently developed `EXTEND` method [@doi:10.1038/s41467-020-20474-9].
Copy link
Member Author

Choose a reason for hiding this comment

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

Updated reference (now published!)


### Survival models (`survival-analysis` analysis module)

We calculated overall survival (OS) as days since initial diagnosis and performed several survival analyses on the OpenPBTA cohort using the [`survival` R package](https://cran.r-project.org/package=survival).
We performed survival analysis for patients by HGG subtype using the Kaplan-Meier estimator [@doi:10.2307/2281868] and a log-rank test (Mantel-Cox test) [@pmid:5910392] on the different HGG subtypes.
Next, we used multivariate cox (proportional hazards) regression analysis [@url:http://www.jstor.org/stable/2985181] to model the following: a) `tp53 scores + telomerase scores + extent of tumor resection + LGG group + HGG group`, in which `tp53 scores` and `telomerase scores` are numeric, `extent of tumor resection` is categorical, and `LGG group` and `HGG group` are binary variables indicating whether the sample is in either broad histology grouping, b) `tp53 scores + telomerase scores + extent of tumor resection` for each `cancer_group` with an N>=3 deceased patients (DIPG, DMG, HGG, MB, and EPN), and c) `quantiseq cell type fractions + CD274 expression + extent of tumor resection` for each `cancer_group` with an N>=3 deceased patients (DIPG, DMG, HGG, MB, and EPN), in which `quantiseq cell type fractions` and `CD274 expression` are numeric.
Next, we used multivariate Cox (proportional hazards) regression analysis [@doi:10.1111/j.2517-6161.1972.tb00899.x] to model the following: a) `tp53 scores + telomerase scores + extent of tumor resection + LGG group + HGG group`, in which `tp53 scores` and `telomerase scores` are numeric, `extent of tumor resection` is categorical, and `LGG group` and `HGG group` are binary variables indicating whether the sample is in either broad histology grouping, b) `tp53 scores + telomerase scores + extent of tumor resection` for each `cancer_group` with an N>=3 deceased patients (DIPG, DMG, HGG, MB, and EPN), and c) `quantiseq cell type fractions + CD274 expression + extent of tumor resection` for each `cancer_group` with an N>=3 deceased patients (DIPG, DMG, HGG, MB, and EPN), in which `quantiseq cell type fractions` and `CD274 expression` are numeric.
Copy link
Member Author

Choose a reason for hiding this comment

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

Found DOI for this ref.

@AppVeyorBot
Copy link

AppVeyor build 1.0.932 for commit 8050704 is now complete.

Found 0 potential spelling error(s). Preview:...
The rendered manuscript from this build is temporarily available for download at:

Copy link
Collaborator

@jharenza jharenza left a comment

Choose a reason for hiding this comment

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

This looks good, and no more ???!

@jharenza
Copy link
Collaborator

The one thing I noticed and wanted to note somewhere is that the reference format is general Manubot format and I am wondering if there will be a way to make the references in the output journal-specific. I can add a new ticket around this, as I think we do not need to address immediately nor prior to sending to co-authors.

@jharenza
Copy link
Collaborator

Update: created #304 for reference style.

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.

🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants