2 | Cite this page as: Vilhuber, Lars. . "{{ page.title }}". {{ site.title }}. Accessed at on . 3 | 4 |
5 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-minimal 2 | title: AEA Data and Code Guidance 3 | description: Guidance for authors wishing to create data and code supplements, and for replicators. 4 | logo: assets/thumbnail_website_logo.jpg 5 | show_downloads: false 6 | -------------------------------------------------------------------------------- /disclaimer.md: -------------------------------------------------------------------------------- 1 | These pages provide *unofficial and preliminary* information as it is being developed the AEA Data Editor. 2 | No information should be construed as official policy of the American Economic Association. For official 3 | policy, please see https://www.aeaweb.org. -------------------------------------------------------------------------------- /template-README.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | This page has permanently moved, please 7 | . 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /citations/chicago-authordate-aea.tex: -------------------------------------------------------------------------------- 1 | % $Id: chicago-authordate-aea.sty,v 0.1 2018-10-03 18:06:54 vilhuber Exp $ 2 | % This is a biblatex style file, meant to correct the display of DOI 3 | 4 | %%%% change display of DOI fields 5 | 6 | \DeclareFieldFormat{doi}{% 7 | \ifhyperref 8 | {\href{https://doi.org/#1}{\nolinkurl{https://doi.org/#1}}} 9 | {\nolinkurl{https://doi.org/#1}}} 10 | -------------------------------------------------------------------------------- /_includes/header.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /assets/css/style.scss: -------------------------------------------------------------------------------- 1 | --- 2 | --- 3 | 4 | @import "{{ site.theme }}"; 5 | 6 | $base-color: #924046; 7 | a { 8 | color: $base-color; 9 | } 10 | 11 | a:hover, a:focus { 12 | color: $base-color; 13 | font-weight: normal; 14 | text-decoration: darken($base-color, 10% ) 15 | } 16 | 17 | body { 18 | color: #222222; 19 | } 20 | 21 | footer { 22 | color: #c5c2c2; 23 | } 24 | 25 | .footeremph { 26 | color: #222222; 27 | text-decoration: underline; 28 | } 29 | 30 | .wrapper { 31 | width: 1200px; 32 | } 33 | section { 34 | width: 800px; 35 | } -------------------------------------------------------------------------------- /citations/chicago-authordate-aea.sty: -------------------------------------------------------------------------------- 1 | % $Id: chicago-authordate-aea.sty,v 0.1 2018-10-03 18:06:54 vilhuber Exp $ 2 | % This is a biblatex style file, meant to correct the display of DOI 3 | 4 | \ProvidesPackage{chicago-authordate-aea}[2018-10-03 v 0.1 biblatex 5 | bibliography style] 6 | 7 | \RequirePackage{biblatex} 8 | 9 | 10 | %%%% change display of DOI fields 11 | 12 | \DeclareFieldFormat{doi}{% 13 | \ifhyperref 14 | {\href{https://doi.org/#1}{\nolinkurl{https://doi.org/#1}}} 15 | {\nolinkurl{https://doi.org/#1}}} 16 | 17 | \endinput 18 | -------------------------------------------------------------------------------- /_includes/footer.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /code/02_codebook_plaintext.do: -------------------------------------------------------------------------------- 1 | // Stata codebook example 2 | /*** 3 | # Codebook example for STATA 4 | 5 | The source code for this file is [here](02_codebook_plaintext.do). 6 | 7 | ## Simple example 8 | 9 | The following is [perfectly acceptable content](02_codebook_plaintext.txt), 10 | but not necessarily pretty to view. 11 | The core code only requires native commands. Note that it is important that 12 | output be to a plaintext log file, as SMCL (Stata's fancy log format) 13 | is not portable. 14 | ***/ 15 | capture close log 16 | sysdir set PLUS "./ado/" 17 | set more 1 18 | set linesize 147 19 | log using "02_codebook_plaintext.txt", replace text 20 | // not run: use my_input_data 21 | di 22 | sysuse auto 23 | /*==== File structure ====*/ 24 | describe 25 | /*==== Summary statistics ====*/ 26 | codebook 27 | qui log c 28 | // also translate this program 29 | // This requires a bit of setup, see 01_codebook_fancy.do 30 | // markdoc "02_codebook_plaintext.do", replace export(md) install 31 | -------------------------------------------------------------------------------- /third-party-request.md: -------------------------------------------------------------------------------- 1 | # Template to be sent to a third-party replication service 2 | 3 | ## Prepare email 4 | 5 | --- 6 | 7 | Dear XXX, 8 | 9 | Could I ask you to conduct a reproducibility check of a manuscript for us? If yes, please prepare a reproducibility report (see below) for the following manuscript, code, and data: 10 | 11 | > Manuscript: Attached. 12 | 13 | > README: Attached. 14 | 15 | > Code and data: (URL) 16 | 17 | Instructions on [how to access pre-publication openICPSR](https://github.com/labordynamicsinstitute/replicability-training/blob/master/openICPSR_training.md) are available. 18 | 19 | Please file your report via reply-all to this email, within the next 10 days. 20 | 21 | Thank you very much in advance. 22 | 23 | --- 24 | 25 | ## Steps for journal 26 | 27 | - [ ] Share openICPSR deposit with the email on file for the replication service 28 | - [ ] Mark the JIRA ticket as outsourced 29 | - [ ] Use the subject line [[AEAREP-XXX] Third party verification request [MANUSCRIPT NUMBER]](mailto:somebody@here.com?subject=[AEAREP-XXX]%20Third%20party%20verification%20request%20[MANUSCRIPT%20NUMBER]) 30 | - [ ] Attach the manuscript and the README provided by the authors 31 | - [ ] CC dataeditor-queue@aeapubs.org 32 | -------------------------------------------------------------------------------- /code/01_codebook_fancy.do: -------------------------------------------------------------------------------- 1 | // Stata codebook example 2 | /*** 3 | # Codebook example for STATA 4 | The source code for this file is [here](01_codebook_fancy.do). 5 | 6 | ## Prettier example 7 | This is a bit more involved example, but illustrates the core code. 8 | 9 | ## Requirements 10 | This fancier example leverages the [`markdown`](http://haghish.com/statistics/stata-blog/reproducible-research/markdoc.php) package as of 2018-10-01. 11 | Here we install it locally to this project. 12 | ***/ 13 | set more 1 14 | set linesize 147 15 | qui shell mkdir ado 16 | sysdir set PLUS "./ado/" 17 | // The following lines need to be run the first time this code is run (not ideal) 18 | // not run: net install github, from("https://haghish.github.io/github/") 19 | // not run: github install haghish/markdoc 20 | // not run: markdoc, install 21 | 22 | /*** 23 | Once the markdoc package is installed, we can create marginally fancier 24 | codebooks as well (see [the output](01_codebook_fancy.md)). 25 | 26 | ## Fancy introduction 27 | For instance we could write a fancy introduction here. 28 | 29 | ## File structure 30 | We can now describe the file structure. 31 | ***/ 32 | sysuse auto 33 | describe 34 | /*** 35 | ## Summary statistics 36 | ***/ 37 | codebook 38 | // also translate this program 39 | // markdoc "01_codebook_fancy.do", replace export(md) install 40 | -------------------------------------------------------------------------------- /protocol-3rd-party-replication.md: -------------------------------------------------------------------------------- 1 | # Protocol for Third-party Verifications 2 | 3 | The AEA's [Protocol for Third-party Verifications](https://www.aeaweb.org/journals/data/policy-third-party) is available on the [AEA website](https://www.aeaweb.org/journals/data/policy-third-party). 4 | 5 | > Alternate protocols are possible, but should be verified with the AEA Data Editor prior to engaging any resources. 6 | 7 | 8 | ## Template email 9 | > Dear [REPLICATOR], 10 | > 11 | > I would like to ask you to conduct a reproducibility verification for the American Economic Association. You have been identified as somebody with access to the right data and resources to conduct this important part of the AEA's publication process. If you are willing, please prepare a reproducibility report (see below) for the following manuscript, code, and data: 12 | > 13 | > Manuscript: Attached. 14 | > 15 | > README: Attached. 16 | > 17 | > Code and data: [CODELOCATION] 18 | > 19 | > Instructions on how to [access pre-publication openICPSR deposits](https://labordynamicsinstitute.github.io/replicability-training-curriculum/using-openicpsr-projects-prior-to-publication.html) are available. 20 | > 21 | > While you conduct the reproducibility checks, I ask that you not communicate with the authors on this topic. Please let us know if you believe you have any conflicts of interest in this matter which would prevent you from conducting an objective check on the reproducibility of the archive. 22 | > 23 | > Please file your report via reply-all to this email, within the next 10 days. 24 | > 25 | > Thank you very much in advance. -------------------------------------------------------------------------------- /step-by-step.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Step by step guidance 3 | layout: withtoc 4 | --- 5 | 6 | The following steps outline what you should expect after conditional acceptance of your manuscript, in compliance with the [AEA Data and Code Availability Policy](https://www.aeaweb.org/journals/policies/data-code): 7 | 8 | 1. [Prepare your data and code replication package](preparing-for-data-deposit.md) (including data citations and provenance information) 9 | 2. [Provide metadata and upload the replication package](data-deposit-aea.md), for verification and subsequently publication. 10 | 3. Submit the [Data and Code Availability Form](https://www.aeaweb.org/journals/forms/data-code-availability) together with your manuscript native files as instructed, and as per guidelines at your journal (for example, [AER guidelines](https://www.aeaweb.org/journals/aer/submissions/accepted-articles/styleguide)). 11 | 4. The editorial office assigns the manuscript to the AEA Data Editor. 12 | 5. The AEA Data Editor team downloads materials, [conducts reproducibility checks](https://social-science-data-editors.github.io/guidance/Verification_guidance.html) , writes [report](https://github.com/AEADataEditor/replication-template/blob/master/REPLICATION.md). 13 | 6. The report is communicated to the editorial office and the Editor of the journal. 14 | - If accepted, the manuscript is copy-edited, and published together with the data deposit as provided by the author. 15 | - If changes need to be made, the report is communicated to the authors, who make changes, until the replication package is accepted. 16 | 17 | 18 |  19 | -------------------------------------------------------------------------------- /template_inquiry_about_DOI_by_editor.md: -------------------------------------------------------------------------------- 1 | (This template can be used by the Data Editor to contact data providers) 2 | 3 | Dear [name], 4 | 5 | the American Economic Association has a data and code availability policy that applies to researchers who submit articles 6 | for publication to our journals. Inter alia, this policy requests that authors provide accurate and persistent information 7 | about how other researchers can find and access data, whether that data be created by the authors or by third parties. Elements 8 | of such information are persistent URLs or Digital Object Identifiers (DOI), description of access conditions, and terms of use. 9 | 10 | One of our authors has used your data, and we are inquiring about any such information you could provide either to us or to 11 | authors upon request. We are looking for 12 | - DOI for specific datasets or files 13 | - URLs or DOI pointing to licenses (or, if the files are license-free, a statement to that effect) 14 | - URLs or DOI pointing to terms of use - the conditions under which researchers may use and possibly republish the data 15 | (this may be the same as the license) 16 | - URLs, DOI, or information regarding how long you will maintain the datasets you make available 17 | If you have such information available, we would be grateful if you could point us in the right direction. If you do not yet have 18 | such information, any plans you might have would be of interest to us. 19 | 20 | This is a new initiative at the AEA, and we understand that historically, much of what we are looking for above was not part of 21 | standard practice in our research community. We are trying to improve the overall transparency and thus reproducible of economics, 22 | and this is part of that effort. 23 | 24 | I would be available to discuss this further with you and your institution. 25 | 26 | Sincerely, 27 | 28 | Data Editor of the American Economic Association 29 | -------------------------------------------------------------------------------- /code/03_codebook_dataMaid.Rmd: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Example codebook in R" 3 | author: "Lars Vilhuber" 4 | date: "October 1, 2018" 5 | output: 6 | html_document: 7 | keep_md: yes 8 | --- 9 | 10 | ```{r setup, include=FALSE} 11 | knitr::opts_chunk$set(echo = TRUE) 12 | packages <- c("dataMaid") 13 | ``` 14 | 15 | ## Pretty example 16 | 17 | There are a variety of ways one can describe data in R, but one of the more convenient ways is to use the [`dataMaid`](https://cran.r-project.org/web/packages/dataMaid/index.html) package on CRAN. 18 | 19 | ### Installing dataMaid 20 | `dataMaid` is on CRAN, so we install it from there. 21 | ```{r install} 22 | # from https://www.r-bloggers.com/loading-andor-installing-packages-programmatically/ 23 | is_installed <- function(mypkg) is.element(mypkg, installed.packages()[,1]) 24 | load_or_install<-function(package_names) 25 | { 26 | for(package_name in package_names) 27 | { 28 | if(!is_installed(package_name)) 29 | { 30 | install.packages(package_name,repos="http://lib.stat.cmu.edu/R/CRAN") 31 | } 32 | library(package_name,character.only=TRUE,quietly=TRUE,verbose=FALSE) 33 | } 34 | } 35 | # calling our two functions: 36 | load_or_install(packages) 37 | ``` 38 | 39 | Then we can easily load it, and use the `makeCodebook()` command. 40 | ```{r sample,message=FALSE} 41 | library(foreign) 42 | # we use the same dataset as for the Stata example 43 | autos <- read.dta("http://www.stata-press.com/data/r9/auto.dta") 44 | library(dataMaid) 45 | makeDataReport(autos, 46 | replace=TRUE, 47 | openResult = FALSE, 48 | codebook = TRUE, 49 | file="codebook_autos.Rmd") 50 | ``` 51 | 52 | The codebook will be called [codebook_autos.pdf](codebook_autos.pdf), but the intermediate RMarkdown file [codebook_autos.Rmd](codebook_autos.Rmd) can also be tweaked. 53 | 54 | ### References 55 | ```{r,results='asis'} 56 | citation(package="dataMaid") 57 | ``` 58 | 59 | -------------------------------------------------------------------------------- /_layouts/redirect.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 |{{ site.description | default: site.github.project_tagline }}
20 | 21 | {% if site.github.is_project_page %} 22 | 23 | {% endif %} 24 | 25 | {% if site.github.is_user_page %} 26 | 27 | {% endif %} 28 | {% if site.show_downloads %} 29 |