Difference between revisions of "Guidelines for Summarizing a Literature Study"

(Template code)
(Template code)
 
(4 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
* assess and describe the outcomes as objective and unbiased as possible
 
* assess and describe the outcomes as objective and unbiased as possible
  
The original authors are highly-welcome to add their own comments or discuss. Our goal is obtaining consencus.
+
The original authors are highly-welcome to add their own comments or discuss. The goal is achieving a consensus within the scientific community.  
  
 
=== Template code ===
 
=== Template code ===
Line 10: Line 10:
 
<pre>
 
<pre>
 
__ NUMBEREDHEADINGS__
 
__ NUMBEREDHEADINGS__
== Paper name ==
+
=== Citation ===
 
Authors, title, year, journal, volume, pages etc in any possible citation style.
 
Authors, title, year, journal, volume, pages etc in any possible citation style.
  
[https://doi.org/10.1371/journal.pone.0074335: Permanent link to the paper]
+
[https://doi.org/10.1371/journal.pone.0074335 Permanent link to the paper]
  
  
Line 23: Line 23:
 
==== Outcome O1 ====
 
==== Outcome O1 ====
 
The performance of ...
 
The performance of ...
 +
 +
Outcome O1 is presented as Figure X in the original publication.
  
 
==== Outcome O2 ====
 
==== Outcome O2 ====
 
...
 
...
 +
 +
Outcome O2 is presented as Figure X in the original publication.
 
   
 
   
 
==== Outcome On ====
 
==== Outcome On ====
 
...
 
...
 +
 +
Outcome On is presented as Figure X in the original publication.
  
 
==== Further outcomes ====
 
==== Further outcomes ====

Latest revision as of 11:37, 25 February 2020

For adding a new page summarizing the results of a published paper, please try to following these guidelines:

  • describe outcomes of a paper using a standardized format by usinig the template below
  • assess and describe the outcomes as objective and unbiased as possible

The original authors are highly-welcome to add their own comments or discuss. The goal is achieving a consensus within the scientific community.

Template code

For creating a new page for "Literature Results", paste the following code into the editor and remove the whitespace in "__ NUMBEREDHEADINGS__":

__ NUMBEREDHEADINGS__
=== Citation ===
Authors, title, year, journal, volume, pages etc in any possible citation style.

[https://doi.org/10.1371/journal.pone.0074335 Permanent link to the paper]


=== Summary ===
Briefly describe the scope of the paper, i.e. the field of research and/or application.

=== Study outcomes ===
List the paper results concerning method comparison and benchmarking:
==== Outcome O1 ====
The performance of ...

Outcome O1 is presented as Figure X in the original publication. 

==== Outcome O2 ====
...

Outcome O2 is presented as Figure X in the original publication. 
 
==== Outcome On ====
...

Outcome On is presented as Figure X in the original publication. 

==== Further outcomes ====
If intended, you can add further outcomes here.


=== Study design and evidence level ===
==== General aspects ====
You can describe general design aspects here.
The study designs for describing specific outcomes are listed in the following subsections:

==== Design for Outcome O1 ====
* The outcome was generated for ...
* Configuration parameters were chosen ...
* ...
==== Design for Outcome O2 ====
* The outcome was generated for ...
* Configuration parameters were chosen ...
* ...

... 

==== Design for Outcome O ====
* The outcome was generated for ...
* Configuration parameters were chosen ...
* ...

=== Further comments and aspects ===

=== References ===
The list of cited or related literature is placed here.