From bd7176a611b8d9c9dfd09b9cf80d53bfdbbfcf42 Mon Sep 17 00:00:00 2001 From: "J. Hathaway" Date: Mon, 6 May 2019 13:52:41 -0600 Subject: [PATCH] first pass at default folder structure. --- .gitignore | 7 +++++++ README.md | 14 ++++++++++++++ derived_data/README.md | 2 ++ documents/README.md | 2 ++ documents/proposal/README.md | 2 ++ documents/reference_material/README.md | 2 ++ personal_folders/README.md | 2 ++ personal_folders/hathawayj/README.md | 2 ++ raw_data/README.md | 2 ++ results/README.md | 2 ++ results/shiny_apps/README.md | 2 ++ scripts/README.md | 2 ++ 12 files changed, 41 insertions(+) create mode 100644 .gitignore create mode 100644 derived_data/README.md create mode 100644 documents/README.md create mode 100644 documents/proposal/README.md create mode 100644 documents/reference_material/README.md create mode 100644 personal_folders/README.md create mode 100644 personal_folders/hathawayj/README.md create mode 100644 raw_data/README.md create mode 100644 results/README.md create mode 100644 results/shiny_apps/README.md create mode 100644 scripts/README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fe34aa0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +.Rproj.user +.Rhistory +.RData +.Ruserdata +blank_project_repository.Rproj +.DS_Store +data \ No newline at end of file diff --git a/README.md b/README.md index b9312cc..9cab835 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # blank_project_repository + A blank project repository for folder structure and naming guidance + +## High-level folders + +- `personal_folders` - This folder has a folder named [lastnamefirstnameletter] for each person on the project. +- `results` - contains the deliverables from the project. +- `scripts` - contains the final scripts that built the items in the `results` folder. Each script should be concise and mapped to the deliverables in the `results` folder. +- `raw_data` has files that are smaller than 100mb provided by the client. Note that a `data` folder can be created in the repository and that it will be ignored for data larger than 100mb. +- `derived_data` has derived data files. Each script should start from a file in the `raw_data` or `data` folder and create an item in this folder. The script that created the derived data object would be in the `scripts` folder and could have the same name as the derived data object. +- `documents` contains a folder for the project proposal and any other `reference_material.` + +## Further Action + +We need to build out the default guidance in the readme.md in each folder. \ No newline at end of file diff --git a/derived_data/README.md b/derived_data/README.md new file mode 100644 index 0000000..b9312cc --- /dev/null +++ b/derived_data/README.md @@ -0,0 +1,2 @@ +# blank_project_repository +A blank project repository for folder structure and naming guidance diff --git a/documents/README.md b/documents/README.md new file mode 100644 index 0000000..b9312cc --- /dev/null +++ b/documents/README.md @@ -0,0 +1,2 @@ +# blank_project_repository +A blank project repository for folder structure and naming guidance diff --git a/documents/proposal/README.md b/documents/proposal/README.md new file mode 100644 index 0000000..b9312cc --- /dev/null +++ b/documents/proposal/README.md @@ -0,0 +1,2 @@ +# blank_project_repository +A blank project repository for folder structure and naming guidance diff --git a/documents/reference_material/README.md b/documents/reference_material/README.md new file mode 100644 index 0000000..b9312cc --- /dev/null +++ b/documents/reference_material/README.md @@ -0,0 +1,2 @@ +# blank_project_repository +A blank project repository for folder structure and naming guidance diff --git a/personal_folders/README.md b/personal_folders/README.md new file mode 100644 index 0000000..b9312cc --- /dev/null +++ b/personal_folders/README.md @@ -0,0 +1,2 @@ +# blank_project_repository +A blank project repository for folder structure and naming guidance diff --git a/personal_folders/hathawayj/README.md b/personal_folders/hathawayj/README.md new file mode 100644 index 0000000..b9312cc --- /dev/null +++ b/personal_folders/hathawayj/README.md @@ -0,0 +1,2 @@ +# blank_project_repository +A blank project repository for folder structure and naming guidance diff --git a/raw_data/README.md b/raw_data/README.md new file mode 100644 index 0000000..b9312cc --- /dev/null +++ b/raw_data/README.md @@ -0,0 +1,2 @@ +# blank_project_repository +A blank project repository for folder structure and naming guidance diff --git a/results/README.md b/results/README.md new file mode 100644 index 0000000..b9312cc --- /dev/null +++ b/results/README.md @@ -0,0 +1,2 @@ +# blank_project_repository +A blank project repository for folder structure and naming guidance diff --git a/results/shiny_apps/README.md b/results/shiny_apps/README.md new file mode 100644 index 0000000..b9312cc --- /dev/null +++ b/results/shiny_apps/README.md @@ -0,0 +1,2 @@ +# blank_project_repository +A blank project repository for folder structure and naming guidance diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 0000000..b9312cc --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,2 @@ +# blank_project_repository +A blank project repository for folder structure and naming guidance