On Github tomwright01 / writing_a_scientific_paper
Created by Tom Wright
Communicate your work to other people.
“Many scientific papers fail to usefully communicate research work to their audience. They focus on the authors instead of on the readers by failing to clarify the motivation for the work or by including unnecessary details. Or they try to impress the readers rather than inform them. As a result, they are interesting to or understandable by only a small set of highly specialized readers. Effective scientific papers, in contrast, are interesting and useful to many readers, including newcomers to the field.”Ryan Lilly
Each author should participate sufficiently to take responsibility for the content.
Authorshop credit should be based only on substantial contributions to:
Activities that do not qualify for authorship include:
These may be acknowledged "Clinical Investigators" or "Participating Investigators" Contributions should be specified.
The principal author sends a memo to all potential authors:
Are you able to take responsibility for the content of this paper? For at least a specific section did you have input to: conception and design, or analysis and interpretation of data and were you involved in drafting the article / section of the article or revising it critically for important intellectual content and were you involved in the final revision of the version to be published.Is the paper:
Open-access (OA) literature is digital, online, free of charge, and free of most copyright and licensing restrictions.
Required for research funded by:CIHR, NSERC, NIH.
OA Repositories OA JournalsDon't perform peer review
May contain unrefereed preprints, refereed postprints, or both.
Perform peer review
Have expenses: peer review, manuscript preparation, server space
Many business models:Author paysInstitution pays (PLOS,BMC)Embargo
ROARMAP - Database of OA repositoriesSHERPA/RoMEO - Database of authors rights by journal
Review the article guidelines:
Clarifies the motivation and prepares readers for the structure of the paper.
The first paragraph is essential. Catch the attention of the audience and convey the importance of the work.
The first sentance should be snappy and profound.
Succincly describe what was done.
If you used standard procedures reference them, explain any deviations.
Justify the statistical methods used.
Explain why you use these methods.
Consider using flow charts, tables etc.
Don't make the reader work through in chronological order. State the important findings first, then use the rest of the paragraph to justify them.
The word significant can only be used when a statistical test was performed.
Do not restate the results, interpret your findings at a higher level of abstraction.
How did your results compare with expected results?
Discuss any weaknesses, explain why it is not practical to address them.
Show what your findings mean in the broader context, what further predictions can be made?
Present information in a format that is easily evaluated by the reader.
Pay attention to axis labels, units etc.
It should be possible to understand a table or figure without referring to the text.
If possible show raw data as well as a summary, e.g. datapoints on a boxplot.
Show error bars (and describe them in the figure legend.
Minimize jargon and acronyms.
Be concise, avoid extra words.
Phrase Replace In order to... To The fact that... delete It is clear that... Clearly It is evident that... EvidentlyUse past tense for results described in the paper.
Use present tense for results from published papers.
Use future tense only for experiments that are planned for the future.
Use first person sparingly, reserve it's use for special emphasis of things "you" uniquely did.
Passive verbs: is, was, has, have, had are boring.
Take care with pronouns it or they to refer to a previous sentence. If in doubt repeat the target in subsequent sentences.
Check the journal style guide.
Use standard abbreviations, (hr, min, sec, mm, l etc.)
Define abbreviations first time they are used. If a paragraph is too heavy with abbreviations consider rewriting.
Don't use abbreviations for terms mentioned less than 3 times.
Paraphrasing other's words too closely may be considered plagiarism.
Self-plagiarism applies to your previous work.
Can be avoided by referencing all information used from other sources.
Must be registered.
ClinicalTrials.gov