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

Line 10: Line 10:
  
  
<code>
+
<pre>
 
== Paper name ==
 
== Paper name ==
 
Authors, title, year, journal, volume, pages etc in any possible citation style.
 
Authors, title, year, journal, volume, pages etc in any possible citation style.
Line 60: Line 60:
 
=== References ===
 
=== References ===
 
The list of cited or related literature is placed here.
 
The list of cited or related literature is placed here.
 
+
</pre>
</code>
 

Revision as of 10:08, 9 August 2018

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. Our goal is obtaining consencus.

Template code for creating a new page for "Literature Results"

Paste the following code into the editor:


== Paper name ==
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 O2 ====
...
 
==== Outcome On ====
...

==== 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.