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

Finalize and build pharmaceuticals manuscript #848

Merged
merged 9 commits into from
Feb 10, 2021

Conversation

rando2
Copy link
Contributor

@rando2 rando2 commented Feb 9, 2021

Description of the proposed additions or changes

This PR:

  1. Removes a comment (based on confirming the text in the manuscript matches the reference)
  2. Removes some EOL whitespace
  3. Adds pharmaceuticals authorship info to metadata.yaml
  4. Sets the individual docx manuscript built to pharmaceuticals

Related issues

#738

Suggested reviewers (optional)

Checklist

  • Text is formatted so that each sentence is on its own line.
  • Pre-prints cited in this pull request have a GitHub issue opened so that they can be reviewed.

@AppVeyorBot
Copy link

AppVeyor build 1.0.3142 for commit 4cb0b6d 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

@cgreene cgreene left a comment

Choose a reason for hiding this comment

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

One missing period!

content/20.pharmaceuticals.md Outdated Show resolved Hide resolved
HM Rando and others added 2 commits February 9, 2021 12:00
Co-authored-by: Casey Greene <cgreene@users.noreply.github.com>
@AppVeyorBot
Copy link

AppVeyor build 1.0.3145 ...

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

@rando2
Copy link
Contributor Author

rando2 commented Feb 9, 2021

Figures are not showing up in the docx build. @vincerubinetti is it possible the changes to rootstock could be involved in this? I can't think of anything else we've done that would have affected it, but I also can't check whether this broke with the update to rootstock because the docx we were building at that time doesn't have any figures!

@vincerubinetti
Copy link
Collaborator

By the changes, you mean the plugin refactor from a couple days ago? manubot/rootstock@87c1195

All of the changes in that PR should only affect the html output, as those files only get inserted in the html build:
https://github.com/manubot/rootstock/blob/main/build/pandoc/defaults/html.yaml

I'm at a loss for why the docx would be different now.

@rando2
Copy link
Contributor Author

rando2 commented Feb 9, 2021

Thanks @vincerubinetti, it was the plugin refactor -- here it was #840 and I saw a couple of files outside the plugins directory were changed (e.g., ci/deploy.sh), so I was hoping there might be some crossover!

I might manually fix this for now because I'm so far behind on getting this out to authors, but I'm curious if @agitter or @cgreene has any of ideas of what might have changed with the docx output? It's got something to do with rendering pictures in Word, I think, because some of them are static and some are dynamic yet none of them are showing up. We know it was still working at #819, which was the last time we built a docx with a figure in it.

@vincerubinetti
Copy link
Collaborator

I saw a couple of files outside the plugins directory were changed (e.g., ci/deploy.sh), so I was hoping there might be some crossover!

My specific rootstock PR didn't touch anything outside of the plugins directory, so perhaps it's been a while since this manuscript pulled from upstream and there have been other rootstock changes that I'm not aware of in that time (like ci/deploy.sh). You should probably ask @dhimmel and @agitter if they know anything else that changed that could've caused this problem.

@agitter
Copy link
Collaborator

agitter commented Feb 9, 2021

I would guess this has more to do with general issues with svg images in docx outputs than any recent rootstock changes. There is some discussion of this in the abandoned pull request manubot/rootstock#40 The final comments there hint that svg images in docx works on some systems but not our CI build environments. Using png images in docx outputs is reliable.

I can help brainstorm general solutions. However, I probably won't get to it until Thursday or Friday. If you want to get this out to co-authors, manually fixing the images this time may be a reasonable workaround.

@vincerubinetti
Copy link
Collaborator

Ah I didn't see that these were SVG files. I didn't think Word really supports SVGs that well. I'm surprised it ever worked at all.

@agitter
Copy link
Collaborator

agitter commented Feb 9, 2021

I checked the docx artifact (pharmaceuticals-manuscript.docx), and the problem is only the svg images. We have .png versions of those already generated. We could switch to the .png versions instead of the .svg temporarily or permanently.

The issue with svg images in docx is a general pandoc issue: https://github.com/jgm/pandoc/issues/4058. There may be a fix coming, but we shouldn't wait for it.

Figure 3 in the docx has extra whitespace at the bottom that could be cropped before the final version is submitted.

The Unicode characters don't show up correctly in the docx either. For example, when I view the docx I see:
image

Co-authored-by: Anthony Gitter <agitter@users.noreply.github.com>
@rando2
Copy link
Contributor Author

rando2 commented Feb 9, 2021

Thanks @agitter, I just noticed that I was wrong about which figure was which! That's great that it's just the svgs. And thank you for catching my oversight on the contributions!

Whitespace issue I can address, and I actually think that the Unicode issue will be an easy fix. It seems like I mostly added the ones that were in the pathogenesis section, which means they were done with html formatting (e.g., TNF-&alpha;). I believe those all rendered correctly, or at least none of us caught issues in the docx and several of us read it closely. In this section, it seems like they are all just the unicode characters themselves. Although this will be more annoying for authors, it's good to know it's not too difficult of a fix!

@AppVeyorBot
Copy link

AppVeyor build 1.0.3146 for commit 18b4f3b 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.3147 for commit 9ec2327 is now complete.

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

@rando2
Copy link
Contributor Author

rando2 commented Feb 9, 2021

@agitter I think I fixed these issues except that I'm not sure where the specification for the file extension for the dynamic figures is provided, since the syntax in the document looks like this--
![ **COVID-19 clinical trials.** ]({{ebm_trials_figure}} "COVID-19 clinical trials"){#fig:ebm-trials secno=1}

Grep isn't helping me figure out which script is pulling the associated image. Do you have any thoughts on where this happens in the pipeline?

@agitter
Copy link
Collaborator

agitter commented Feb 9, 2021

The file extensions are hidden in too many layers of indirection to find easily. They are being specified in .json files on the external-resources branch, and Manubot reads those to populate the values of the template variables in the text.

I pushed fd68382 to the external-resources branch to switch from svg to png. This should apply automatically starting with the next build. That change will also apply to PDF and HTML builds so we can double-check those. If it looks bad in the HTML, I could look into using svg by default and png for docx.

@cbrueffer
Copy link
Collaborator

cbrueffer commented Feb 9, 2021

Commenting here in addition to gitter, the links in references 210 and 211 (Synairgen) seem to 404, can anyone confirm? They have a nonsensical headline ("people") as well.

Copy link
Collaborator

@agitter agitter left a comment

Choose a reason for hiding this comment

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

I re-ran the GitHub Actions build and the .png images show up in the docx now. They look okay in the PDF and HTML but a little pixelated. I can try increasing the dpi later.

Commenting here in addition to gitter, the links in references 210 and 211 (Synairgen) seem to 404, can anyone confirm? They have a nonsensical headline ("people") as well.

I plan to do a final read through Wednesday or Thursday and will try to remember to fix this. We can use a manual reference to set the titles and switch to the Web Archive URL.

@rando2
Copy link
Contributor Author

rando2 commented Feb 10, 2021

Thank you @cbrueffer and @agitter for catching that! I believe I was looking at press releases on their website about a week ago, so it's odd that they're already 404-ing.

I think the first one can be found here: https://www.globenewswire.com/news-release/2020/03/18/2002574/0/en/Synairgen-to-start-trial-of-SNG001-in-COVID-19-imminently.html

And the second here: https://www.icpcovid.com/sites/default/files/2020-08/200720-Synairgen-annmounces-positive-results-from-trial-of-SNG001-in-hospitalised-COVID-19-patients.pdf

I'm not sure why the links from their own website no longer work and I don't know what the best way to handle this would be.

I'm going to merge this in but I'll open an issue based on @cbrueffer's comment!

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

Successfully merging this pull request may close these issues.

6 participants