Difference between revisions of "Editing Guidelines"

From replication research for social sciences
Jump to navigation Jump to search
(Created page with "== Info == Status: Choose one from (published/forthcoming/under-review/work-in-progress/private/other). "Private" includes unpublished manuscripts or correspondence, etc. Tit...")
 
 
(One intermediate revision by the same user not shown)
Line 26: Line 26:
 
We strongly encourage users to input tables following the syntax of [https://www.mediawiki.org/wiki/Help:Tables wiki markup]. Inserting a screenshot of the table is discouraged because then the input will be difficult to process for future readers.
 
We strongly encourage users to input tables following the syntax of [https://www.mediawiki.org/wiki/Help:Tables wiki markup]. Inserting a screenshot of the table is discouraged because then the input will be difficult to process for future readers.
  
Use the ''Upload file'' under ''Tools'' on the left bar to upload figures. the figure should be renamed as ''doi + figure no.''. For example, figure 2 from a paper whose doi is 10.1017/S0003055410000626  should be renamed as "10.1017-S0003055410000626figure2.png". Notice that "/" and other ilegal characters are replaced by "-". Then link the figure using "[[File:]]" following the syntax [https://www.mediawiki.org/wiki/Help:Images inserting images].
+
Use the ''Upload file'' under ''Tools'' on the left bar to upload figures. The image file should be renamed as ''doi - figure no.''. For example, figure 2 from a paper whose doi is 10.1017/S0003055410000626  should be renamed as "10.1017-S0003055410000626-figure2.png". Notice that "/" and other ilegal characters are replaced by "-". Then link the figure using "[[File:]]" following the syntax [https://www.mediawiki.org/wiki/Help:Images inserting images].
 +
 
 +
For figures from unpublished papers, the image file should be renamed as ''doi of paper being replicated - rep - author of replication - figure no.''. For example, "10.1017-S0003055410000626-rep-Jane-Doe-figure2.png"

Latest revision as of 13:34, 24 July 2020

Info

Status: Choose one from (published/forthcoming/under-review/work-in-progress/private/other). "Private" includes unpublished manuscripts or correspondence, etc. Title: For published papers, include the full title. For unpublished replications, add "- rep by authorname" behind. For example, "The Tragedy of the Nomenklatura: Career Incentives and Political Radicalism during China's Great Leap Famine - rep by John Doe" Authors: Year: Journal: Doi: Make sure to link the original page if the paper is published.

Analyses

Presentation of results should follow a consistent format. Key components include:

  1. Use the caption as the section title using "=== title ==="
  2. Method: Give the name of the method and link it to a reliable external source. If the method is solely descriptive, say so instead.
  3. Analytical tools: Report the analytical tools used in the paper. Ideally, the information should be sufficient for a third party to replicate the analysis if orginal data is accessible. Examples are: name, version of the software and/or packages, seed number if applicable.
  4. Data Source: Name the source of the data, preferably with a link to it.
  5. Replication Status: List replications here with internal links. For any given order, multiple pages can be listed. All replication pages are encouraged to include the code using Uploading Files on the left-side bar.
  6. Orders of replication:
    1. L0: Verifiability. Same data, same models. L0 pages are strongly encouraged to report the name and version of software and/or packages; and other technical details to facilitate replication.
    2. L1: Robustness. Same data, different models. Using the same method with different specifications or using a different method aiming for the same results both fall into this category.
    3. L2: Repeatablility. Different data, same models. The models should be reasonably unchanged to test if the same results can be observed in a different sample.
    4. L3: Generalizability. Different data, different models.
  7. Table or figure of results.

Tables and Figures

We strongly encourage users to input tables following the syntax of wiki markup. Inserting a screenshot of the table is discouraged because then the input will be difficult to process for future readers.

Use the Upload file under Tools on the left bar to upload figures. The image file should be renamed as doi - figure no.. For example, figure 2 from a paper whose doi is 10.1017/S0003055410000626 should be renamed as "10.1017-S0003055410000626-figure2.png". Notice that "/" and other ilegal characters are replaced by "-". Then link the figure using "[[File:]]" following the syntax inserting images.

For figures from unpublished papers, the image file should be renamed as doi of paper being replicated - rep - author of replication - figure no.. For example, "10.1017-S0003055410000626-rep-Jane-Doe-figure2.png"