-
Notifications
You must be signed in to change notification settings - Fork 7
/
35-Write.Rmd
811 lines (587 loc) · 38.8 KB
/
35-Write.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
# (PART) Reporting and reading research {-}
# Reporting and writing research {#WritingResearch}
<!-- Introductions; easier to separate by format -->
```{r, child = if (knitr::is_html_output()) {'./introductions/35-Write-HTML.Rmd'} else {'./introductions/35-Write-LaTeX.Rmd'}}
```
<!-- Define colours as appropriate -->
```{r, child = if (knitr::is_html_output()) {'./children/coloursHTML.Rmd'} else {'./children/coloursLaTeX.Rmd'}}
```
## Introduction {#Chap37-Intro}
<div style="float:right; width: 222x; border: 1px; padding:10px">
<img src="Illustrations/pexels-ivan-samkov-4240494.jpg" width="200px"/>
</div>
Research needs to be effectively communicated and shared, so the results can be used, evaluated and built on by others.
The purpose of writing about research is to effectively and clearly communicate.
Research may be shared using face-to-face or online presentations (Sect.\ \@ref(PreparingPresentations)) or written documents (Sect.\ \@ref(WritingDocuments)).
The style and expectations vary widely between these two formats, between disciplines, and between journals in the same discipline.
Hence, this chapter gives general comments about writing, rather than specific requirements.
Formal guidelines for writing about research exist, for both experimental [@hopewell2022update] and observational studies [@von2007strengthening], though we will not discuss these specifically.
Since different disciplines and journals have their own styles, read articles from your discipline or target journal for examples of the required style and formatting.
## General writing advice {#WritingGeneralTips}
The purpose of writing about research is to effectively and clearly communicate the research.
With this in mind, some general advice is given below.
* *Write carefully and precisely*.
Use simple, clear but technically-correct language. \tightlist
Use the [Glossary] if necessary.
Carefully choose every word you use to ensure it conveys the correct and intended meaning.
\ \
@oppenheimer2006consequences concluded, from experimental studies, that students often believe the use of fancy words makes them appear smarter.
However, he recommended students 'write clearly and simply if you can, and you'll be more likely to be thought of as intelligent' (p.\ 153).
* *Use correct spelling, grammar, punctuation and formatting.*
Use (but do not rely upon) a spell checker and grammar checker; use a dictionary.
Specifically:
* Do *not* confuse similar words (there/their/they're; your/you're; affect/effect; chose/choose; etc.).
* Capitalise correctly.
* Use apostrophes correctly.
For example, *it's* is only ever an abbreviation for *it is*.
* Be careful with plurals.
For example, 'a group *was*' rather than 'a group *were*'; 'the sample *was*' rather than 'the sample *were*'.
* *Be inclusive*.
Unless specifically referring to men or women, use inclusive language (e.g., 'fire-fighter', not 'fireman'; 'nurse' rather than 'male nurse').
* *Take care using comparative terms.*
For example, writing 'this treatment is *better*' must be clarified.
Better than *what*?
And 'better' in what sense: cost? ease of use? patient outcomes?
* *Use terminology consistently.*
Different words may be used for the same concept in research and statistics.
Use the term that is common in your discipline; most of all, be consistent.
* *Be clear, concise and complete*.
Place material in an Appendix (Sect.\ \@ref(WritingOther)) if it will interrupt the flow of the narrative.
Often, this material can be made available online if too lengthy in printed form.
* *Ensure pronouns clearly identify the nouns they refer to.*
For example, consider this sentence: 'When the weeds and crops were sprayed, its growth rate reduced by $80$%'.
In this sentence, it is unclear what *its* refers to: the growth rate of the weeds, the crops, or both.
* *Ensure verbs and nouns agree*.
Both the nouns and verbs in a sentence should be singular or plural.
For example, 'the rats *was* weighed' should be 'the rats *were* weighed'.
Usually, 'data' is considered plural ('datum' is the singular; 'dataset' is also singular), so write 'the data *were* right skewed' rather than 'the data *was* right skewed' (but the latter use is becoming more common).
In any case, be consistent.
* *Avoid leaps of logic, and reaching conclusions unsupported by the evidence*.
Ensure your conclusions are consistent with the evidence in the study.
\ \
For example, a student project found that the proportion of provisional drivers (those yet to get a full licence) was *higher* in the free university car park, compared to paid car parks.
They concluded that provisional drivers seek to 'save money by parking in free car parks'.
This *may* be true, but is not supported by the evidence.
The evidence simply shows a difference in proportions, but does not explain *why*.
* *Present the facts in an unbiased manner, and avoid promoting personal opinions*.
For example, do not describe results as 'exciting'.
Because academic writing generally shuns personal opinions, writing in third person ('the fertiliser was applied') is usually (but not always) preferred over writing in first person ('I applied the fertiliser').
<!-- :::::: {.cols data-latex="[T]"} -->
<!-- ::: {.col data-latex="{0.48\textwidth}"} -->
<!-- * *should* use inclusive language (e.g., 'fire-fighter', not 'fireman'). -->
<!-- * *should* avoid ambiguity. -->
<!-- * *should* use terminology consistently. -->
<!-- * *should* use simple, clear but technically-correct language. -->
<!-- * *should* present the facts in an unbiased manner. -->
<!-- * *should* be clear, concise and complete. -->
<!-- * *should* avoid unnecessary repetition. -->
<!-- * *should* should ensure that pronouns clearly identify what they are referring to. -->
<!-- ::: -->
<!-- ::: {.col data-latex="{0.04\textwidth}"} -->
<!-- \ -->
<!-- ::: -->
<!-- ::: {.col data-latex="{0.46\textwidth}"} -->
<!-- * *should not* contain unnecessary words and phrases. -->
<!-- * *should not* be haphazard, jumbled or makes leaps of logic. -->
<!-- * *should not* promote personal opinions (such as describing results as 'exciting', and so on). -->
<!-- * *should not* reach conclusions unsupported by the given evidence. -->
<!-- * *should not* overstate what has been learnt from the study. -->
<!-- ::: -->
<!-- :::::: -->
<!-- ::: {.example #Overstating name="Overstating conclusions"} -->
<!-- A student project found that the proportion of provisional drivers (those yet to get a full open licence) was higher in free university car parks, compared to paid university car parks. -->
<!-- They concluded that provisional drivers seek to 'save money by parking in free car parks'. -->
<!-- This *may* be true, but the evidence from their *observational* study cannot demonstrate this. -->
<!-- For example, the proportion may be higher in the free car parks as those car parks may be closer to their classrooms. -->
<!-- The study simply shows evidence of a difference in proportions, but does not study *why*. -->
<!-- To learn the reason, provisional drivers could be surveyed. -->
<!-- ::: -->
<!-- Because academic writing avoids personal opinions, writing in first person ('I applied the fertiliser') is usually (but not always) preferred over writing in third person ('the fertiliser was applied'). -->
Writing well is difficult; editing can be painful; revising is time-consuming.
Revise your document carefully as many times as necessary; having someone else read and comment on your writing can be useful.
::: {.importantBox .important data-latex="{iconmonstr-warning-8-240.png}"}
Many authors have stated
`r if (knitr::is_latex_output()) {
'variations of this phrase:'
} else {
'[variations of this phrase:](https://quoteinvestigator.com/2021/12/11/understood/)'
}`
> Don't write so that you *can* be understood; write so that you *can't* be misunderstood.
Be unambiguous: say what you mean, and mean what you say.
:::
<!-- SEM2 2022: Canvas Project Task 2B Group 67 -->
:::{.example #WriteWell name="Write what you mean"}
A student project at my university asked:
> Are dark-coloured car owners more likely to park undercover?
They actually meant:
> Are drivers of dark-coloured cars more likely to park undercover?
Don't just be understood; avoid being *mis*understood!
:::
<!-- ::: {.example #ShortSentences name="Short sentences"} -->
<!-- The first sentence should be accessible and engaging. -->
<!-- Here is a very poor first sentence: -->
<!-- > Until recently, atypical hemolytic uremic syndrome (aHUS), conventionally defined in the pediatric literature as a syndrome of the triad of renal failure, microangiopathic hemolytic anemia, and thrombocytopenia without a prodrome of hemorrhagic diarrhoea, has received little attention in adult practice because the patients are commonly given the diagnosis of thrombotic thrombocytopenic purpura (TTP) or TTP/HUS and treated as TTP with plasma exchange, augmented in refractory cases with rituximab and sometimes even splenectomy. -->
<!-- > -->
<!-- > --- @tsai2014mechanistic, p. 187 -->
<!-- ::: -->
<!-- ::: {.example #WriteCarefully name="Writing carefully"} -->
<!-- This sentence appeared in a published article (@PsychologyMysore, p. 14; emphasis added): -->
<!-- > 600 teachers, from both Government and Private Schools, have been *drowned* by random sampling. -->
<!-- This sentence is poor: no-one has ever been *drowned* by random sampling. -->
<!-- Possibly, the authors mean that teachers were '*overwhelmed* by participation in many research studies'. -->
<!-- However, later the article states: "Using random sampling a total number of $600$ teachers were selected..." (p. 17), so the initial wording is *wrong*, and I suspect the sample probably wasn't *random* either! -->
<!-- ::: -->
<!-- Finally, excellent advice, with a humorous slant, appears [on the offical *plain language* website of the US government](https://www.plainlanguage.gov/resources/humor/how-to-write-good/), including these gems: -->
<!-- * Avoid Alliteration. Always. -->
<!-- * Prepositions are not words to end sentences with. -->
<!-- * Avoid cliches like the plague. (They're old hat.) -->
<!-- * Eschew ampersands & abbreviations, etc. -->
<!-- * Contractions aren't necessary. -->
<!-- * One should never generalize. -->
<!-- * Be more or less specific. -->
<!-- * Exaggeration is a billion times worse than understatement. -->
<!-- * Don't repeat yourself, or say again what you have said before. -->
<!-- * Don't use commas, that, are not, necessary. -->
<!-- * Never use a big word when a diminutive alternative would suffice. -->
<!-- * Use youre spell chekker to avoid mispeling and to catch typograhpical errers. -->
<!-- * Use the apostrophe in it's proper place and omit it when its not needed. -->
<!-- * If you reread your work, you can find on rereading a great deal of repetition can be avoided by rereading and editing. -->
## Ethics when writing {#EthicsWhenWriting}
As always, ethical practice is important (Sect.\ \@ref(Ethics))\index{Ethics}, including when writing about research.
Some relevant issues are given below.
* *Producing reproducible research*.
When possible, research should be *reproducible* (Sect.\ \@ref(ReproducibleResearch)).\index{Research!reproducibility} \tightlist
This includes describing the protocol,\index{Protocol} and making available any data (when possible; sometime this is not ethical or permitted) and any instructions or code used to analyse the data.
* *Authorship*.
Ensure that everyone who has made an intellectual contribution is listed as an author.
@brand2015beyond suggests authorship be considered for those involved with:
:::::: {.cols data-latex=""}
::: {.col data-latex="{0.03\textwidth}"}
\
<!-- an empty Div (with a white space), serving as a column separator, to replicate an *indent* -->
:::
::: {.col data-latex="{0.27\textwidth}"}
* conceptualisation.
* methodology.
* software.
* data analysis.
* investigation.
* resourcing.
* data curation.
:::
::: {.col data-latex="{0.02\textwidth}"}
\
<!-- an empty Div (with a white space), serving as
a column separator -->
:::
::: {.col data-latex="{0.65\textwidth}"}
* creating images or taking photographs.
* writing, including writing drafts, reviewing and editing.
* visualization.
* supervision.
* project administration.
* funding acquisition.
:::
::::::
* *Acknowledgements*.
An optional *Acknowledgements* section can be used to acknowledge research funding bodies, and people who supported the research.
Avoid writing 'The authors would like to thank...'; instead, actually thank them: 'We thank...'.
Reviewers of the article (who are almost always volunteers) are usually thanked also.
* *Use of artificial intelligence (AI)*.\index{Artificial intelligence}
Any use of AI in the study should be disclosed.
This includes using AI *during* the research (e.g., generating figures or research design) or when writing *about* the research.
The description should indicate where AI was used, which AI systems (such as ChatGPT) were used, and how they were used.
AI also may make mistakes, so any material generated using AI should be verified by the authors.
* *Plagiarism*.\index{Plagiarism}
Writing about research almost always refers to, and builds on, others' work: to formulate the research question, to establish ideas and to explain the background of the research.
However, *plagiarism* (using other people's words and ideas without acknowledgement) *must* be avoided.
All sources used when writing research should be acknowledged.
\ \
Plagiarism is a serious offence: it is theft of intellectual property.
*Do not plagiarise*; use quotes if necessary and cite the work of others as needed.
Plagiarism applies to words, text, images, photographs, ideas, etc.
::: {.example #PlagiarismEG name="Plagiarism"}
@shamim2014development published an article to discourage plagiarism.
Later, the
`r if (knitr::is_latex_output()) {
'article was retracted'
} else {
'[article was retracted](http://www.e-ijd.org/article.asp?issn=0019-5154;year=2014;volume=59;issue=5;spage=473;epage=475;aulast=Shamim)'
}`
because parts of the article were plagiarised.
:::
## Preparing presentations {#PreparingPresentations}
*Presentations* are often used to share progress reports of research, or give an overview of completed research.
They are used at conferences, workshops, and progress meetings, and may be given to peers, stakeholders, funding bodies, small groups of other researchers, or work teams.
Presentations should be adapted to suit the time allocated and the audience: a conference presentation to your research peers should be different from a presentation to a progress meeting.
Presentations are mostly a *verbal* (speaking) and *visual* (preparing slides) medium.
As a *verbal* medium, speak slowly, clearly, loudly, and with expression.
Use eye contact, and practice.
Ensure you keep to your allocated time.
Ensure technical or unusual words are pronounced correctly; aids to correct pronunciation of many unfamiliar terms have been given in this book.
As a *visual* medium, presentations usually omit technical details and give the audience an overview of the major points and processes; sharing tedious technical details is unlikely to produce an engaging presentation.
Presentations usually focus on the *why* and the *what* of the research.
Presentations may encourage audience members to learn more by reading your written documents (Sect.\ \@ref(WritingDocuments)).
Presentations also tend to use graphs, images, short sentences, and minimal text.
Presentation software encourages the use of fancy fonts, transitions and animations, but these are usually more distracting than informative; avoid.
Ensure your fonts and colours are readable from a distance (especially in tables and graphs).
Using bullet points on slides, while common, is not necessary; short sentences are fine.
Slides should *not* contain information that you simply *read* to the audience; a good presenter adds important details around the structure provided by information on the slides.
The slides *guide*, but do not have to *tell*, your story of your research.
## Writing articles {#WritingDocuments}
Written documents are more likely to be formally written and prepared than presentations.
Unlike presentations, written documents tend to provide details of *how* the research was conducted.
Written documents may be journal articles, progress reports, reports to stakeholders, or funding applications; these are all referred to as 'articles' in what follows, for brevity.
::: {.importantBox .important data-latex="{iconmonstr-warning-8-240.png}"}
Journal articles, and most other written documents too, should contain sufficient details so that other professionals can repeat the study (Chap.\ \@ref(Protocols)); i.e., the research should, as far as possible, be reproducible (Sect.\ \@ref(ReproducibleResearch)).\index{Research!reproducibility}
:::
Articles usually have a more formal structure than presentations.
Sometimes the acronym AIMRaD\index{AIMRaD} is used to remember these sections:
* _**A**bstract_,
* _**I**ntroduction_,
* _**M**ethods_,
* _**R**esults_, and
* _**D**iscussion_ (or *Summary*, or *Conclusions*).
These components capture the six-step research process in this book (Fig.\ \@ref(fig:ReportStructure)).
(ref:Structure) The connection between the article and the steps studied. The *Abstract* briefly covers all aspects of the study, and the *Discussion* explains what has been learnt through the process.
```{r ReportStructure, fig.cap="(ref:Structure)", fig.align="center", fig.width=6.5, out.width='75%'}
source("R/showAIMRAD.R")
showAIMRAD(debug = FALSE)
```
### Article titles {#WritingTitles}
Titles are important: poor titles can discourage a reader from reading an article.
A title should clearly describe the main purpose of the article.
Sometimes this is achieved by posing questions in the title ('Do warning lights and sirens reduce ambulance response times?'; @data:Brown2000:WarningLights) or providing answers in the title ('No harm from five year ingestion of oats in coeliac disease'; @data:Janatuinen2002:Coeliac).
As far as possible, avoid overly-specific technical language and uncommon abbreviations in the title.
<!-- ::: {.example #ArticleTitles name="Article title"} -->
<!-- A example of a good title is: -->
<!-- > Beauty sleep: experimental study on the perceived health and attractiveness of sleep deprived people -->
<!-- > -->
<!-- > --- @data:axelsson:beautysleep -->
<!-- A example of a poor article title is: -->
<!-- > The nucleotide sequence of a 3.2 kb segment of mitochondrial maxicircle DNA from Crithidia fasciculata containing the gene for cytochrome oxidase subunit III, the N-terminal part of the apocytochrome b gene and a possible frameshift gene; further evidence for the use of unusual initiator triplets in trypanosome mitochondria -->
<!-- > -->
<!-- > --- @sloof1987nucleotide -->
<!-- ::: -->
### Abstract {#WritingAbstract}
The *Abstract* (or *Summary*, or *Overview*) is a short section at the start of an article summarising the *whole* article, including the results; it is *not* an introduction.
The *Abstract* is the most important part of any article: it is the only part that many people will read.
Some journals require a *structured abstract*, where the *Abstract* contains specific headings (for example, *Introduction*, *Methods*, *Results*, and *Conclusion* (or *Discussion*)).
### Introduction {#WritingIntroduction}
The purpose of the *Introduction* is to:
* show how the research fills a gap in existing knowledge, by discussing existing literature (sometimes the *Literature review* forms a separate section).
* gain the interest of readers, and encourage them to read more of the article.
* establish the context and background.
* define the language, acronyms and definitions used in the study.
* introduce the theoretical groundwork of the subject.
* state the purpose of the article: why it was written, and what the authors hope to learn.
### Methods {#WritingMethods}
The *Methods* section (sometimes called *Materials and Methods* or similar) explains how the data were obtained.
This includes:
* how the *sample* was identified and located.
* how the data were *collected* from the individuals (the data collection *protocol*).\index{Protocol}
* how external and internal validity was maximised, and confounding managed;
* how the data were *analysed*, including the software\index{Computers and software} (and version number) used, and the statistical methods used.
* what specialized equipment was used (don't list pencils, rulers, paper, etc.).
### Results {#WritingResults}
The *Results* summarise the conclusions from the analysis, especially regarding the initial RQ.\spacex
The *Results* section:
* shows all the relevant findings from the research.
* presents a summary of the data: the number of observations, the number of missing values, and a verbal description of important variables.
* presents tabular, numerical and/or graphical summaries of the data and relationships of importance.
* gives a brief verbal interpretation of these summaries.
* gives the results from any hypothesis tests and confidence intervals.
* identifies trends, consistencies, anomalies, etc.
* does *not* provide interpretations or explanations of the results (that is the purpose of the *Discussion*).
Unless the dataset is small, the data itself is usually not given (though may appear in an Appendix or online).
::: {.importantBox .important data-latex="{iconmonstr-warning-8-240.png}"}
Cutting-and-pasting software output into reports is rarely acceptable, except for carefully-prepared graphs (Chap.\ \@ref(SummariseComments); Sect.\ \@ref(WritingGraphsTables)).
:::
### Discussion {#WritingDiscussion}
No new information should be presented in this section.
This section:
* summarises the results.
* gives a short evaluation of the results.
* answers the stated RQ (i.e., makes a conclusion).
* discusses limitations (Chap.\ \@ref(Interpretation)), strengths, weaknesses, problems, challenges.
* tries to anticipate and respond to potential questions about the research.
Readers should reach the conclusions based on the *evidence* presented.
Sometimes, articles have separate *Conclusion* and *Discussion* sections; sometimes they are combined.
### Referencing {#Referencing}
\index{Plagiarism}
<!-- ::: {.example #EthicsSarkar name="Plagiarism"} -->
<!-- A microbiologist had articles retracted due to fraud, including self-plagiarism and reusing figures that were claimed to come from different studies (@Chatterjee2015, p.\ $1\,527$). -->
<!-- ::: -->
The *References* (or *Bibliography*) section gives the full citations of any work referenced, in the required format (such as APA, Harvard, etc.).
Most journals have strict guidelines for how references should be listed and formatted.
### Appendices {#WritingOther}
Sometimes an *Appendix* is included, which contains important material that would otherwise break the flow of the article's narrative.
The *Appendix* may include large tables, data, images, discussions of technical details, mathematical development, and so on.
Sometimes, this material is placed online.
## Specific advice {#WriteSpecificAdvice}
### Constructing tables, graphs and images {#WritingGraphsTables}
\index{Tables!preparing}\index{Graphs!preparing}\index{Software output!graphs}\index{Graphs!using software}
Good figures and tables take time and care to prepare (Chap.\ \@ref(SummariseComments)).
Their purpose should always be to *display information in the simplest, clearest possible way*, and to highlight the important information.
In general, tables, graphs and images:
* *should* be discussed (not just presented) and referred to in the text.
* *should* be clear and uncluttered.
* *should* include units of measurement (such as kg or inches) where appropriate.
* *should* be able to be understood without reference to the article, as far as possible.
* *should* use easy-to-read fonts and colours: for example, ensure the font size is sufficiently large when placed in the article at the final size.
* *should* avoid using different colours, line types or fonts unless these have a purpose (i.e., to differentiate between groups in the study); if they are used, their purpose should be explained (e.g., using a figure legend).
* *should not* include *chart junk* (unnecessary additions), such as artificial third dimensions for graphs (Sect.\ \@ref(GraphsConstructing)) and unnecessary lines in tables.
Figures and images typically have captions *below*, while tables typically have captions *above*.
The source of images (e.g., the photographer) should be acknowledged (as ethical practice),\index{Ethics} when appropriate.
Table should use very few horizontal lines, and no vertical lines.
### Presenting numbers
Any numbers presented should be rounded appropriately.
Software may report more decimal places (or more significant figures) than necessary.
When appropriate, ensure units of measurement are given.
Be consistent and careful with decimal numbers.
Some journals require numbers to be written with a leading zero (e.g., $P = 0.024$), and some do not (e.g., $P = .024$).
Counts are usually written in words when fewer than ten (or sometimes twelve), and otherwise presented using digits.
However, numbers are written in full when starting a sentence ('Thirty-seven people volunteered').
::: {.importantBox .important data-latex="{iconmonstr-warning-8-240.png}"}
Numbers taken from software output may need to be sensibly rounded before being included in a report (including in tables and graphs), and units of measurement added.
:::
### Lexically ambiguous words {#LexicalAmbiguity}
<div style="float:right; width: 222x; border: 1px; padding:10px">
<img src="Illustrations/writing-828911_1920.jpg" width="200px"/>
</div>
Readers should not be able to misinterpret your meaning, so write *carefully* and *precisely*.
One potential source of confusion is words with a different meaning in research compared to every-day use or in other disciplines (called *lexical ambiguity*; @dunn2016learning).
Some specific words where care is needed are given below.
* *Average*:\index{Averages}\index{Mean!sample}\index{Median!sample}
In research, 'average' refers to *any* way of measuring the typical value (Sect.\ \@ref(ComputeAverage)) including the mean\index{Mean!sample} and the median,\index{Median!sample} but also other measures too (like geometric means, for instance).
Use the specific word 'mean' or 'median' when that is what you intend.
* *Confidence*:\index{Confidence intervals}
In research, 'confidence' is usually used in the phrase 'confidence interval' (Sect.\ \@ref(CIInterpretation)).
Take care when using 'confidence' in other contexts.
* *Control*:\index{Control}
In research, a 'control' is usually used in the context of a control group (Def.\ \@ref(def:Control)), but may have other meanings in other disciplines.
* *Correlation*:\index{Correlation}
In research, correlation describes the (often linear) relationship between two *quantitative* variables (Sect.\ \@ref(CorrCoefficients)).
In general use, 'correlation' may mean any 'association' between any two variables.
* *Estimate*:\index{Estimate}
In research, 'estimating' means to *calculate* an estimate for an unknown population parameter using sample information.
In general use, 'estimate' often means to make an educated guess.
* *Experiment*:\index{Study types!experimental}
In research, an experiment is a specific type of research study (Sect.\ \@ref(ExperimentalStudies)).
The word 'study' can be used to talk about research studies more generally.
* *Independent*:\index{Independence}
This word has many different uses in statistics and research, in science, and in general use.
The word 'independent' in this book refers to events that do not impact each other in a probabilistic sense (Sect.\ \@ref(Independence)).
* *Intervention*:\index{Intervention}
In research, an 'intervention' (Sect.\ \@ref(Intervention)) is specifically when the researchers can manipulate the comparison.
* *Normal*:\index{Normal distribution}
In research, 'normal' often refers to the 'normal distribution' (Chap.\ \@ref(NormalDistribution)).
If this is *not* the meaning you intend to convey, consider using the word 'usual' or similar.
* *Odds*:\index{Odds}\index{Probability}
In research, 'odds' has a specific meaning (Sect.\ \@ref(QualOdds)) and is not the same as probability.
In general use, 'probability' and 'odds' are often used interchangeably.
* *Population*:\index{Population}
In research, the 'population' refers to a larger group of interest (Def.\ \@ref(def:Population)).
In general use, 'population' often refers to groups of people specifically.
* *Random*:\index{Random}
In research, 'random' has a specific meaning: based on impersonal chance.
In general usage, it often means 'haphazard' or 'without planning'.
* *Regression*:\index{Regression}
In research, 'regression' refers to the mathematical (often linear) relationship between two quantitative variables (Chap.\ \@ref(CorrelationRegression)).
* *Sample*: \index{Sample}
In research, we usually have '*one* sample of $30$ hyenas'; in some disciplines, this could be described as 'taking $30$ samples of hyenas'.
* *Significant*:\index{Statistical significance}\index{P@$P$-values!one-tailed}
In research, 'significance' is usually understood to refer to 'statistical significance' (Sect.\ \@ref(AboutPvalues)).
If this is *not* the meaning you intend to convey, consider using the word 'substantial' or similar.
* *Variable*:\index{Variables}
In research, a 'variable' is a characteristic that can vary from individual to individual (Def.\ \@ref(def:Variable)).
Some *symbols* may also have different meanings in other disciplines.
Ensure the meaning of symbols and notation is clearly defined.
## Chapter summary
Communicating research is a vital step in the research process.
Writing clearly is important.
Presentations are a verbal and visual medium, and usually focus on the major points and conclusions rather than the *how*.
Written documents are usually formal, and include details of *what* was done.
They should be written carefully and precisely, using the best technically-correct words.
Use short sentences for easier reading and omit unnecessary words.
Remember: 'Don’t write so that you *can* be understood; write so that you *can't* be misunderstood'.
## Quick review questions {#Chap40-QuickReview}
::: {.webex-check .webex-box}
Are these statements true or false?
1. Using long, obscure words makes writing sound more scientific. \tightlist
`r if( knitr::is_html_output() ) {torf( FALSE )}`
1. Presentations generally focus on the details of how the study was done.
`r if( knitr::is_html_output() ) {torf( FALSE )}`
1. The *Introduction* should explain why the study was done.
`r if( knitr::is_html_output() ) {torf( TRUE )}`
1. Numbers should be given to as many decimal places as possible, for the greatest accuracy.
`r if( knitr::is_html_output() ) {torf( FALSE )}`
1. The design of the study should be explained in detail in the *Methods* section.
`r if( knitr::is_html_output() ) {torf( TRUE )}`
:::
## Exercises {#WriteExercises}
[Answers to odd-numbered exercises] are given at the end of the book.
`r if( knitr::is_latex_output() ) "\\captionsetup{font=small}"`
::: {.exercise #WriteWordChoice}
1. \tightlist Select the correct word to use to complete this sentence: *to*, *too* or *two*?
'Liquid fertiliser was applied [______] pots each morning at 9am.'
1. Select the correct word to use to complete this sentence: *its* or *it's*?
'Each kangaroo was observed for signs that [______] tracking device caused discomfort.'
1. What are the problems with this sentence?
'We took $50$ samples of students; the average age of the $50$ students was $26.2$.'
1. What is the problem with this text?
'The subjects are not blinded.
Because the subjects would clearly know they were in a study.'
:::
::: {.exercise #WriteWordChoice2}
1. \tightlist Select the correct word to use to complete this sentence: *there*, *their* or *they're*?
'The subject were told to eat [______] snacks at about 8am.'
1. What is the problem with this text?
'The sample of pedestrians were all taken on a Thursday.'
1. Select the correct word to use to complete this sentence: *affect* or *effect*?
'The [______] of the diet was to increase the blood pressure.'
1. What is the problem with this sentence?
'The new formulation produces better concrete'.
:::
::: {.exercise #WriteAmbiguous}
1. Explain how this sentence can be misinterpreted, and write an improved version:
'There was one rat in the cage that was male.'
1. Explain how this sentence can be misinterpreted, and write an improved version:
'The research assistant recorded the pH of the lake water in the beaker after removing weeds.'
:::
::: {.exercise #WriteAmbiguous2}
1. Explain how this sentence can be misinterpreted, and write an improved version:
'Fertiliser was applied to one of the fields that was in liquid form.'
1. Explain how this sentence can be misinterpreted, and write an improved version:
The new diet lost more weight, on average, than the traditional diet.'
:::
::: {.exercise #WriteAmbiguous3}
1. Explain how this statement can be improved:
'A significant change in the weight gain of the pigs is expected to be found'.
2. Explain how this statement can be improved:
'The data is summarised in Table\ 2.'
:::
::: {.exercise #WriteAmbiguous4}
1. Explain how this statement can be improved:
'There is a correlation between sex of the person and chance of contracting the disease'.
2. Explain how this statement can be improved:
'The group were asked to sign a consent form.'
:::
::: {.exercise #WriteExercisesDecimals}
@oyerinde2019investigation state (p.\ 1):
> The regression correlation coefficients of $0.999996066$ and $0.999653453$ were obtained for the temperatures and speeds respectively [as associated with the time the engine had been running].
What is the problem with this statement?
:::
::: {.exercise #WriteExercisesLikelyToDie}
@david2007patients published an article entitled 'Are patients with self-inflicted injuries more likely to die?'
What is the problem with this title?
:::
<!-- Owen A., Quinn H. SEM1 2019 -->
::: {.exercise #WriteExercisesStudent1}
In a student project, students compared the mean reading speed for people when reading text displayed in one of two different fonts.
Their RQ was:
> Which font allows [...] students to read a pangram the fastest, between a default and what is considered to be a 'easy to read' font.
(A pangram is a sentence that uses every letter of the alphabet at least once.)
In their *Abstract*, the conclusion was given as:
> The Georgia font [...] is therefore the faster of the two.
1. Explain why this is a poorly-worded RQ.
Rewrite the RQ.
1. Explain what is wrong with the conclusion.
Rewrite the statement.
:::
<!-- Ned B., Olivia F. SEM1 2019 -->
::: {.exercise #WriteExercisesStudent2}
In a student project, the heights that students could jump vertically were compared, starting from a squat or standing position.
Every student in the study performed both jumps.
Critique the *numerical summary* produced by the research team (Table\ \@ref(tab:WriteExercisesProject2)).
:::
```{r WriteExercisesProject2}
WEStudent1 <- array( dim = c(1, 7))
rownames(WEStudent1) <- c("")
colnames(WEStudent1) <- c("$n$",
"Mean",
"Standard deviation",
"Standard error",
"Confidence interval $95$\\%",
"$t$ value",
"$P$ value")
WEStudent1[1,] <- c(50,
7.480,
4.674,
0.661,
"\\text{$6.152$ to $8.808$}",
11.316,
0.000
)
if( knitr::is_latex_output() ) {
kable(pad(WEStudent1,
surroundMaths = TRUE,
targetLength = c(2, 4, 5, 5, 0, 6, 0),
decDigits = c(0, 2, 3, 3, 0, 3, 3)),
format = "latex",
align = "c",
longtable = FALSE,
escape = FALSE,
col.names = c("$n$",
"Mean",
"deviation",
"error",
"interval $95$\\%",
"$t$ value",
"$P$ value"),
caption = "A numerical summary of the data, showing how much higher the standing jump height is compared to the squat jump.",
booktabs = FALSE) %>%
kable_styling(font_size = 8) %>%
row_spec(0,
bold = TRUE) %>%
add_header_above( c(" " = 1,
" " = 1,
" " = 1,
"Standard" = 1,
"Standard" = 1,
"Confidence",
" " = 1,
" " = 1),
line = FALSE,
bold = TRUE)
}
if( knitr::is_html_output() ) {
kable(pad(WEStudent1,
surroundMaths = TRUE,
targetLength = c(2, 4, 5, 5, 0, 6, 0),
decDigits = c(0, 2, 3, 3, 0, 3, 3)),
format = "html",
align = "c",
longtable = FALSE,
caption = "A numerical summary of the data, showing how much higher the standing jump height is compared to the squat jump",
booktabs = TRUE)
}
```
<!-- Elizabeth C., Amy (Olivia) G., Sarah F. SEM1 2019 -->
::: {.exercise #WriteExercisesStudent3}
The aim of a student project was 'to determine if the proportion of males and females that use disposable cups on Campus is the same'.
The two variables observed on each person in the study were (a)\ whether the person used a disposable cup, and (b)\ the sex of the person.
In reporting the results in their *Abstract*, the students state:
> Based on the sample results, the $95$% confidence interval for the population mean number of disposable cups used by males and females is between $0.690$ and $1.625$. Meaning that the population mean is likely to fall between those two intervals.
Critique this statement.
:::
<!-- Jake Q., Reece E. SEM1 2019 -->
::: {.exercise #WriteExercisesStudent4}
The aim of a student project was 'to determine if the average hang time is different between two types of paper plane designs'.
The two variables in the study were: design type (Basic Dart; Hunting Flight), and the hang time of the flight of the plane (in seconds).
In reporting the results in their *Abstract*, the students state:
> Very strong evidence proving a difference ($P = .000$) between the Basic Dart mean hang time ($881.84\pm 140.73\millis$) and the Hunting Flight mean hang time ($1504.19\pm 699.86\millis$).
> $95$%\ CI for the means of The Basic Dart ($829.29$ -- $934.39$) and the Hunting Flight ($1242.86$ -- $1765.52$).
Critique this statement.
:::
<!-- QUICK REVIEW ANSWERS -->
`r if (knitr::is_html_output()) '<!--'`
::: {.EOCanswerBox .EOCanswer data-latex="{iconmonstr-check-mark-14-240.png}"}
**Answers to *Quick Revision* questions:**
**1.** False.
**2.** False.
**3.** True.
**4.** False.
**5.** True.
:::
`r if (knitr::is_html_output()) '-->'`