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

Removes cross-links given shortness of document #298

Merged
merged 7 commits into from
Dec 28, 2020

Conversation

fmaguire
Copy link
Collaborator

@fmaguire fmaguire commented Dec 18, 2020

Closes #266

And provides a draft figure for #261

SVG (prepared in inkscape but any vector graphics program should be
fine) available for modification and image embedded at front of
manuscript.
Copy link
Collaborator

@rasbt rasbt left a comment

Choose a reason for hiding this comment

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

The figure is really awesome!

Below are just some suggested tweaks to the text:

Since we use AE in the rest of the text, changing the following would be good for consistency:

  1. optimisiation -> optimization
  2. regularise -> regularize

We also decided to remove 2nd person everywhere. So, below are some suggestion (but there may be better ways to reword those instances)

  1. your DL model -> a DL model
  2. peculiarities of your data -> peculiarities of the data
  3. why your model -> why a model

Lastly, maybe the following change would make it sound a tad letter in 9)

  1. derived from model -> derived from a model

@Benjamin-Lee
Copy link
Owner

Is it standard to have a figure before the introduction heading? Or should it go immediately after?

@Benjamin-Lee
Copy link
Owner

Also, this figure is 100% what we should be using as a thumbnail: https://github.com/Benjamin-Lee/deep-rules/blob/master/thumbnail.png

Can you update that file as well?

@Benjamin-Lee Benjamin-Lee linked an issue Dec 23, 2020 that may be closed by this pull request
@rasbt
Copy link
Collaborator

rasbt commented Dec 23, 2020

Is it standard to have a figure before the introduction heading? Or should it go immediately after?

Some papers have so-called "graphical abstracts" which are essentially figures that go next/below the abstract. Otherwise it is not standard. My Ph.D. advisor was pretty strict about that: she never allowed a figure to appear before it is referenced in the text. I think most people are more relaxed about that these days but it would maybe be weird to put it above the heading if it is not a graphical abstract.

@fmaguire
Copy link
Collaborator Author

A graphical abstract was kinda my thinking but happy to move it into the introduction.

I'm knee deep in the latest covid variant stuff but will try to get that updated and thumbnail added ASAP

@Benjamin-Lee
Copy link
Owner

No rush at all. Thanks for the great work!

@rasbt
Copy link
Collaborator

rasbt commented Dec 23, 2020

A graphical abstract was kinda my thinking but happy to move it into the introduction.

I think that would be great, we just have to make sure whether the journal supports that, @Benjamin-Lee do you know more about this?

@Benjamin-Lee
Copy link
Owner

I've never seen it at PLOS Comp Bio, only figure 1 pseudo-graphical abstracts. This is their page on figures but it clearly either doesn't apply to Ten Simple Rules articles or isn't enforced. Specifically, it says not to use article title (violated in the antiracist lab paper) and to use Times/Helvetica font (violated by PE Bourne himself).

@fmaguire
Copy link
Collaborator Author

Updated as per issue discussion.

content/02.intro.md Outdated Show resolved Hide resolved
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.

It looks great in the PDF artifact

@agitter agitter merged commit 611dcfa into Benjamin-Lee:master Dec 28, 2020
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.

Remove links to tips Add a figure/infographic listing the ten tips?
4 participants