Browse Source

added repro instructions

alecristia 3 months ago
parent
commit
0dbd29c9f6
2 changed files with 23 additions and 5 deletions
  1. 23 5
      README.md
  2. BIN
      to-download-zip.jpg

+ 23 - 5
README.md

@@ -6,13 +6,31 @@ This repository contains the data and the code necessary to reproduce the result
 
 This repository is structured as follows :
 
-* CODE: contains the code necessary to preprocess the and to replicate the analysis of the paper
-* DATA: contains the data which is used for the analyses
-* DATASETS: contains the data sets which are used in this paper. Access to the data sets is only necessary to replicate the content of DATA (i.e. compilation of whole the metrics, children age, etc.). If you are not a LAAC member of trusted member, you cannot have access to this data. For more information, contact [Alejandrina Cristia](mailto:alecristia@gmail.com).
+* CODE: contains the code necessary to preprocess the and to replicate the analysis in the paper
+* data_output: contains the data which is used for the analyses in the paper
 * OUTPUT: contains the derived data (ICCs) computed by the script `all-analyses.R` using the data found in DATA
-* plots: contains the plots shown in the paper
+* input: contains the data sets which are used in this paper. Access to the data sets is only necessary to replicate the content of DATA (i.e. compilation of whole the metrics, children age, etc.). If you are not a LAAC member of trusted member, you cannot have access to this data. For more information, contact [Alejandrina Cristia](mailto:alecristia@gmail.com).
 
-# Data Access
+# Reproducing the paper analyses
+
+
+
+
+Some readers may want to check our materials for reproducibility. To regenerate our supplementary materials, you will need [RStudio](https://www.rstudio.com/). For further information on using Rmd for transparent (knittable) analyses, see [Mike Frank & Chris Hartgerink's tutorial](https://libscie.github.io/rmarkdown-workshop/handout.html).
+
+
+If you simply want to check the reproducibility of the paper analyses, you can download a zipped version from [our GIN repo](https://gin.g-node.org/laac-lscp/relival), by clicking on the button that looks like a downward pointing arrow, near the top right of the page (under Publications; see to-download-zip.jpg).
+
+1. Unzip the downloaded zip folder.
+4. Double click on the CODE folder, and on SM.Rmd to launch RStudio with the correct working directory (or if RStudio is already running, change working directory into the unzipped folder)
+5. Click on the "knit" button near the top of the RStudio window
+6. If anything fails, the most likely issue will be that you are missing a library. For most of the packages, you can install the package through the GUI menu or by typing in the commands section (near the bottom of the RStudio window) `install.package("LIBRARYNAME")` (replace LIBRARYNAME with the package that the system said was not found). If the package missing is papaja, please follow instructions [here](https://github.com/crsh/papaja).
+7. If anything looks different, please double-check that you are using the same versions of all packages by looking at the capture of the environment at the very end of the .pdf file
+
+
+# Raw Data Access
+
+Raw data access is NOT necessary for you to reproduce the supplementary analyses, and thus the numbers and figures in the manuscript. At present, the raw data is only accessible with additional ethics and security approval.
 
 ## Re-using the dataset
 

BIN
to-download-zip.jpg