first pass at default folder structure.

BYUIDSS · May 6, 2019 · bd7176a · bd7176a
1 parent da63f0b
commit bd7176a
Show file tree

Hide file tree

Showing 12 changed files with 41 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,7 @@
+.Rproj.user
+.Rhistory
+.RData
+.Ruserdata
+blank_project_repository.Rproj
+.DS_Store
+data
diff --git 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.
diff --git a/derived_data/README.md 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -0,0 +1,2 @@
+# blank_project_repository
+A blank project repository for folder structure and naming guidance
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# blank_project_repository
		A blank project repository for folder structure and naming guidance