1- ---
2- editor_options :
3- markdown :
4- wrap : 72
5- ---
6-
71# File Structure
82
93This section details emLab's organizational stucture for Google
@@ -44,7 +38,7 @@ Google Docs/Sheets/Slides. Everything else is stored at GRIT.
4438
4539### General Structure
4640
47- ```
41+ ```
4842Google Drive
4943 |__ My Drive
5044 | |__ ... whatever files you have on your personal Google Drive ...
@@ -71,7 +65,7 @@ The emLab Google Shared Drive is organized into three main folders:
7165
7266### Project Folder Structure
7367
74- ```
68+ ```
7569Google Drive
7670 |__ Shared drives
7771 |__ emLab
@@ -113,7 +107,7 @@ the Google Shared Drive, except it also has folders for `data`.
113107
114108### General Structure
115109
116- ```
110+ ```
117111|__ emLab
118112 |__ central-emlab-resources
119113 |__ communications
@@ -134,15 +128,15 @@ The emLab GRIT data directory is organized into five main folders:
134128
135129- ` data ` : includes the centralized emLab data directory of the
136130 commonly used datasets we work with across projects (see Sections
137- \@ ref( emlab-data-directory-overview) and \@ ref( emlab-data-directory)
131+ @ sec- emlab-data-directory-overview and @ sec- emlab-data-directory
138132 for more on this)
139133
140134- ` projects ` : includes data and files on past (archive) and current
141135 projects
142136
143137### Project Folder Structure
144138
145- ```
139+ ```
146140|__ emLab
147141 |__ projects
148142 |__ archived-projects
@@ -160,8 +154,7 @@ Each project folder on GRIT must contain the following 6 folders:
160154
161155- ` data ` : This data folder will contain a ` data_overview ` spreadsheet
162156 and all of the intermediate datasets as well as output datasets
163- associated with the project (see Section
164- \@ ref(project-data-directory) for more on this). Be sure to also add
157+ associated with the project (see @sec-project-data-directory for more on this). Be sure to also add
165158 a copy of your final datasets to the ` emlab/data ` data directory.
166159
167160- ` deliverables ` : final reports, paper manuscripts, other final
@@ -201,7 +194,7 @@ multiple projects. More detail is provided in the subsequent sections.
201194** All** data used in a project should live in this project-specific
202195repository. To help keep track of project data, we highly recommend
203196creating and maintaining a ` data_overview ` Google sheet on the Google
204- Shared Drive (see Section \@ ref( project-data-directory) for more
197+ Shared Drive (see @ sec- project-data-directory for more
205198information). This overview spreadsheet will provide a centralized
206199summary of the data inputs and outputs for a project, and also allow
207200teams to keep track of the status of adding the data to the ` emlab/data `
@@ -214,10 +207,10 @@ To illustrate how each of these subfolders might be used, consider the
214207following. A team may receive data from partners, extract data from
215208external sources, compile survey responses, create a new dataset from a
216209literature review, or use results from previous projects as input. These
217- data are termed “ raw data” and should never be directly modified - ** all
210+ data are termed " raw data" and should never be directly modified - ** all
218211of the errors, mistakes, and gremlins should be kept in the original
219212versions** . Instead, they should be processed / cleaned, and then
220- exported as “ clean data” that is actually used in analyses. The script
213+ exported as " clean data" that is actually used in analyses. The script
221214used to do the processing / cleaning then acts as a reproducable record
222215of everything that was done to the raw data.
223216
@@ -237,7 +230,7 @@ input for analyses within this project. The `output` folder will then
237230contain the stock assessment results that might be relevant to other
238231projects.
239232
240- ```
233+ ```
241234|__ emLab
242235 |__ projects
243236 |__ current-rojects
@@ -257,14 +250,14 @@ emLab projects once the project is complete. To do this, any `output`
257250data (and ` raw ` data if it is not already there) should be moved to the
258251` emlab/data ` folder, as described below.
259252
260- #### ` emlab/data ` {#emlab-data-directory-overview}
253+ #### ` emlab/data ` {#sec- emlab-data-directory-overview}
261254
262255As a general rule, this folder contains all data * used* and * produced*
263256by emLab projects. The idea is to make it easier for people to find data
264257that has been used in previous projects, as well as to use previous
265258results as inputs for new projects. In other words, it is the place to
266259store data that could be used commonly across multiple projects. Please
267- see Section \@ ref(# emlab-data-directory) for an overview of metadata
260+ see @ sec- emlab-data-directory for an overview of metadata
268261that should be included with each dataset.
269262
270263To illustrate types of data that should be in the ` emlab/data ` folder,
@@ -282,7 +275,7 @@ data. **All datasets in this folder should be contained within their own
282275folders that include at minimum the data and metadata files.** For
283276example, a file structure for the two datasets mentioned above might be:
284277
285- ```
278+ ```
286279|__ emLab
287280 |__ data
288281 |__ upsides
@@ -302,7 +295,7 @@ relatively straightforward with the metadata file and a single csv file.
302295However, the folder containing the RAM database is more complicated as
303296this is a dataset that is re-released every so often as a new version.
304297Specific guidelines for organizing different types of data within the
305- ` emlab/data ` folder are discussed in detail in Section \@ ref( data) .
298+ ` emlab/data ` folder are discussed in detail in @ sec- data .
306299
307300## GitHub Structure
308301
@@ -367,15 +360,15 @@ As such, you go to GitHub and create the following four repositories:
367360
368361You'll clone the Blue Future repo into your comuter, using the usual:
369362
370- ```
363+ ```
371364git clone https://github.com/emlab-ucsb/BlueFuture.git
372365```
373366
374367Now, instead of cloning the repos for each paper and the app into their
375368own folder, you'll navigate into your local BlueFuture folder. Then,
376369instead of cloning them there, you can just do:
377370
378- ```
371+ ```
379372git submodule add https://github.com/emlab-ucsb/Paper1.git
380373```
381374
0 commit comments