4 Organization
Folders are organized into a hierarchical structure to clearly delineate project segments, improve searchability, and ensure reproducibility across time.
4.1 Folder structure
There is a delicate balance between deep and shallow folder structures. If too shallow, too many files in one folder are difficult to search. If too deep, too many clicks are required to find a specific file.
Y:/NRAS/soil-health-initiative
is the parent folder for all WaSHI content.
The state-of-the-soils
subfolder uses date- (each year has its own subfolder) and categorical- based (dataset and documentation that span across years) folder structures.
Y:/NRAS/soil-health-initiative/state-of-the-soils/
├── _complete-dataset
├── 2019_scbg
├── 2021_sampling
├── 2022_sampling
├── 2023_sampling
├── 2024_sampling
├── data-management
├── data-sharing
├── data-sources
├── maps
├── projects
├── qapp
├── sop
├── training-videos
├── equipment-inventory.xlsx
├── archived-sample-inventory.xlsx
└── sos-impacts.xlsx
Within each year subfolder, use sub-subfolders for planning, forms, data, and processes to maintain a reproducible workflow each year. See the 2023_sampling
folder tree for an example:
Y:/NRAS/soil-health-initiative/state-of-the-soils/2023_sampling/
├── applications
├── coc
├── equipment
├── field-forms
├── forms
├── gis
├── lab-data
├── labels
├── management-surveys
├── public-docs
├── purchases
├── reports
├── sample-id-assignments
├── scripts
├── 2023-data-tracking.xlsx
└── 2023_post-season-wrap-up.docx
4.2 Archive folders
When too many drafts or versions clutter a subfolder, create a new folder with the naming convention of archive-folder-description
. Place the old drafts there. Leave the most current, accurate file in the main folder.
For example, the most recent sample labels for each conservation district are listed in the top level completed-labels
folder, and previous working drafts were moved to the archive-labels
folder.
Y:/NRAS/soil-health-initiative/state-of-the-soils/2023_sampling/labels/completed-labels
├── archive-labels
│ ├── cowlitz-county_labels.docx
│ ├── ferry-cd_labels.docx
│ ├── lewis-cd_labels.docx
│ └── stevens-cd_labels.docx
├── cowlitz-county_labels_v2.docx
├── ferry-cd_labels_v2.docx
├── ...
├── south-yakima-cd_labels.docx
├── stevens-cd_labels_v2.docx
└── walla-walla-cd_labels.docx
4.3 Code-based project organization
Code-based projects should be organized according to Section 9.1.1 in the code style guide.