File organization and naming conventions are often unique to the lab and can be highly personalized; the important thing is to be consistent and to write them down. Spending a little time on file management strategies early in the project planning process can save lots of time (and headaches) later. After determining conventions for file naming and organization, document and share them with collaborators, faculty advisors, or anyone else who may need access to the data. Lab groups should establish a convention for the lab and save it to a shared space so that everyone can follow the same conventions.
Use file naming conventions
- Make file names unique, including the most important identifying information of the project. File names should be short, so do not try to include all of these, but elements of a good file name may include:
- project name, acronym, or research data name
- study title
- location information
- researcher initials
- date (consistently formatted, i.e. YYYYMMDD)
- version number
- Use underscores to separate elements; avoid special characters, spaces, and periods other than the one before the file extension. Dashes are also acceptable, especially when working with HTML files.
- Use leading zeros when incorporating numbers to enable sorting (a sequence of 1-100 should be numbered 001-100).
- File names should be short enough to be readable, while still conveying enough pertinent information. While some operating systems can handle file paths (file name AND directory route) more than 255 characters in length, many tools and operating systems impose shorter limits. For this reason, it is generally advisable to keep file names as short as possible, ideally no more than 32 characters. ThisIsJustWhatThirtyTwoLooksLike.txt
Good filename example: DV_ICPOES_20101115_JDSv2.dat
Bad filename example: my Data @DryValley November 15 2010.v2.dat
DV is the site code (Dry Valley), ICPOES is the instrument from which the data originated, 20101115 is the date of the sample run on the instrument, JDS are the initials of Jane Doe Scientist and this is the second version of the data file.
Keep track of versions (version control)
It is important to keep track of versions when working with data. There are many benefits, most importantly the ability to revert data to an earlier version instead of starting from scratch or worse, having to regenerate data. There are three basic ways to keep track of versions.
Some tools, like Electronic Lab Notebooks or Box assign version numbers, and that is one option for managing versions of data. Other options include using a naming scheme or version control software. Some best practices for working with versions include:
- Save an untouched copy of the raw data, and leave it that way. Always work on something other than the "safe" untouched copy (it is always possible to go back to the "safe" data and make a new copy in order to start from scratch).
- Avoid ambiguous labels, such as 'revision', 'final', 'final2', etc. Instead, use a file naming convention (like v001, v002 or v1_0, v1_2, v2_0).
- Use a directory structure naming convention that includes version information.
- Use tools that automatically assign version numbers to manage the data. It may be a good idea to test this method to make sure that it is possible to revert to earlier versions and that the tool functions as expected.
- If appropriate, use version control software (such as SVN, or Git). A coding project may be a good candidate for using version control.
Document and use directory structure naming conventions
Do not rely on directory structure to provide critical information about the file contents. Directory top-level folders should include the project title, unique identifier, and date (year), but the files themselves should be well-described independent of the directory structure. Consider creating a brief description of the contents of major folders and providing an overview of the directory structure. This can be a text document or readme file that is stored in a top-level folder or shared space. The level of detail to strive for is enough to help someone else understand the contents and organization of your files in your absence.