jwbowers / TestStatRIInterference

Test statistic selection for randomization inference with interference
1 stars 0 forks source link

Prepare for replication #5

Closed jwbowers closed 8 years ago

jwbowers commented 8 years ago

I think that people can download a release as a zip file without needing github. One issue with downloading the release and doing "make" is that it will take a very long time on any personal computer. So, we could include the .rda files in the release archive (they are currently in ~/Dropbox/TestRIInterferenceProducts plus some "Draft mode" or just some text about planning for the time required for the replication.

Anyway, this issue reminds us to get ready to go from a private production git repository to a public replication repository (or to move to http://osf.io). Mark do you have thoughts about this?

jwbowers commented 8 years ago

I'm assigning this issue to Mark for the moment, because I think he's thought about it the most. I would like to not only have stuff in their dataverse, but make this repository public at some point. I'm tempted to just do something like making a new and cleanish branch that then becomes the master branch.

For now, we need to follow the following directions from the PA email:

Political Analysis requires that authors make replication materials publicly available prior to publication. The data and code for your article must be uploaded to the Political Analysis Dataverse at http://vdn.iq.harvard.edu/dvn/dv/pan and cited in the final version of your manuscript. Below are instructions on how to do this. We will forward your final manuscript to production only after we have verified your compliance with this requirement.

PA Dataverse instructions:

  1. Go to: http://dvn.iq.harvard.edu/dvn/dv/pan and click "Create New Study" link on upper right box.
  2. Enter cataloging fields to describe your data file(s), such as title, author name(s), abstract, year, citation to article, etc.
  3. Save your the cataloging information, click Add Files, and upload your data files, code, documentation, and an explanation of what each of the files are. We recommend you upload tabular data files in one of the formats Dataverse presently recognizes, in which case it will process the files and provide additional formats to the end user.
  4. After all the files are uploaded, click "Send study for review"
  5. You will receive the citation to your replication data set when you upload it. Please insert the complete citation in your manuscript’s references, and refer to this in both your author’s note and in a footnote in your manuscript around where you first describe your data or analysis.
  6. When you have completed this process please email confirmation to politicalanalysis@hss.caltech.edu.

Exceptions: You are only required to provide enough information to replicate the results in your article, not all the data in your possession or even in your data set. However, the more information you provide, the more likely someone will follow upon your article, which would be good for you, your article, and PA. If your data require confidentiality, you should anonymize the relevant variables or cell values. If you need an exception to this policy, please contact the editors.

jwbowers commented 8 years ago

Initial dataverse upload complete using the make archive command that Mark kindly had in the Makefile all this while!