Skip to content

Commit

Permalink
Adding readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
rosemm committed Oct 22, 2024
1 parent 6794792 commit b81632b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
5 changes: 4 additions & 1 deletion reports/notebooks/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
These are reports for DART data analysis.
These are reports for DART data analysis.

Preliminary data extraction and cleaning happens in `src/scripts`.
Interim data files created during the cleaning process are stored in `data/interim` and/or `data/deidentified`, and then those cleaned data files are used in the notebooks here.
7 changes: 7 additions & 0 deletions src/scripts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
These scripts contain all the code needed to create the data needed to replicate analyses in the `reports/notebooks` directory.
To go from raw data to analysis files, run the scripts here in order (start with 00_setup.R, then 01_redcap_api.R, etc.).
You will need API access to the REDCap projects where the raw data are.

The scripts `functions_data_cleaning.R` and `functions_plotting.R` each contain a handful of custom functions used in the data cleaning or analysis code for this project.
When custom functions are used, they are generally accompanied by a comment noting that they are saved in `functions_data_cleaning.R` or `functions_plotting.R`.
They will also be called with `source()` at the beginning of the file using them.

0 comments on commit b81632b

Please sign in to comment.