README.md

In holmesjoli/archiveR: Archiving Tools for R

Git Archive R

One issue that I've often faced in analytics is how to connect output (data, visualizations, and reports) with the code used to generate that output. The team will deliver output to the client/partner and then continue to develop the code base. If the client/partner has a specific question then the team has to back-track to figure out which code was used to create that particular output. A lot of teams archive their output use timestamps, e.g. data_20171019_124590. While this can be a good method for data archiving for some teams, this method doesn't easily allow an analyst to be able to backtrack and see which code created that specific output. This can also create issues if data is created and then used as an input farther downstream because it means that the filename is changing whenever the data are re-processed.

The archiveR package combines several steps important to data archiving purposes into one package.

First, we commit our code and extract the branch, unique 6-character hash, and message to be used when naming the archive.

Next we run the archiving functions which create a directory structure that serves two functions a) easy access to the current data and b) an archive of data can be extracted using the unique 6-character hash.

Example File Structure

Project/
|___Data/
|   |___Processed/
|       |___Current/
|              data.csv
|              summary_data.csv
|       |___Archive/
|                master_90r68d.zip
|___Deliverables/
|   |___Current/
|       fig1.png
|       fig2.png
|   |___Archive/
|       master_90r68d.zip

The archiveR automattically creates the Current and Archive folders. Then it adds the specified files to the Current folder and zips the files from the Current folder using the current code commit and add the Archive folder.

Commit and Archive Sample Code

Sample Code is located ./archiveR/R/sample_code.R

1. Navigate the repository's root directory, e.g. cd archiveR
2. To write out data to the Current folder type Rscript R/sample_code.R

3. To write out data to the Current folder and Archive the data type Rscript R/sample_code.R -c "commit message" -e [e-mail] -n holmesjoli -p gitHubPassword

4. Adding the --commit (-c) command triggers the script to add the data/output to the Archive folder

5. Adding the --add_branch (-b) command is an optional argument. Including this command will add the branch name to the beginning of the archive zip filename.
6. Adding the --add_message (-m) command is an optional argument. Including this command will add the message to the end of the archive zip filename.

holmesjoli/archiveR documentation built on May 11, 2019, 3:05 p.m.