Organising your files

It's good practice to established a file organisation scheme at the start of your project, before the number of files proliferates and you loose track of file names or file location.

As data files can be organised in many different ways your aim is to develop an organisation scheme that works for your research. Thinking about how you want to browse your files may help you to devise a scheme.
 

Tips for organising your files

• Make use of folders to help organise your data files into meaningful and useful groups.

• Folder names should be meaningful and convey concisely the content of the files inside.

• Structure folders hierarchically with a limited number of high-level folders for broad topics, and more specific folders within these.

• Avoid too many layers in your hierarchy, up to three or four is manageable, any more and you may find it difficult to navigate.

• Sensitive data (e.g. participant records) should be stored in separate folders with appropriate access controls.

• Agree a file organisation scheme that everyone will follow when working with other researchers. If you are new to a research group, check if there's a scheme to follow.

• It's a good idea to document your file organisation scheme: recording the naming convention and any abbreviations or codes you will use, and what should go into each folder. If you save this as a 'readme' text file and store it in your project's top level folder, you (and others) will be able to access it easily.

File naming

Good file and folder naming improves searching, helps you and others distinguish documents from one another, allows documents to be sorted into a logical order, and makes it easier to interpret documents and information from their file name.
 

Best practice for file naming

• Files should be named consistently.

• File names should be short but descriptive.

• Think about ordering the elements within a file name logically, and to enable you to sort your files in the way you want.

• Avoid spaces in file names, use capitals and underscores instead e.g. FileName.xxx or file_name.xxx

• Avoid special characters (~ ! @ # $ &), periods or slashes in file names.

• YYYYMMDD is a good format for dates, and to sort files chronologically.

• If you use sequential numbering, add leading zeros (e.g. 001, 002, ...010, 011 ...100, 101, etc.) for clarity, and to sort files numerically.

Version control

It's important to be able to distinguish between different versions or drafts of your files, to avoid working on older or outdated copies, or worse overwriting important data.

Version control or versioning is a system to record changes to a file over time. And, if you are working with others, it is useful to link versions with the time and the author of the change.
 

Things you can do to manage different versions of your data

• File naming: Include clear version information in a file name (e.g. v1, v1-1, v2, v2-1, v2-2, v2-3) using the first number for major changes and the second for minor changes. Include the author of the change (e.g. v2-3_LP) if you are working in a group and need to keep track of who made the changes.

• Version control tables: Document changes in a version control table. Within the document recording the version number, date of the change, name of the person making the change, and the purpose or nature of the change.

• Version control systems: Automated systems that keep track of the changes made to a file or files over time. With a history of all the changes made, it's possible to see each change and to revert back to a previous version. These systems are particularly useful for the collaborative development of code or software e.g. GitHub.
   

Research Coding Club has an introduction to version control: a crash course in git basics and version control with Git and GitHub. Guidance on versioning is also available from the UK Data Service.

• Non-digital data

  Although this guidance concentrates on digital data, you should remember to extend the same care and attention to data held in physical form.

  Physical files, folders and materials also need to be organised in a meaningful and consistent way, and the organisation system devised should be well documented.

This video looks at the different aspects of file organisation, including tips and best practices.