Skip to content

Using naming conventions · Changes

Page history
Update Using naming conventions authored by Christian Evenhuis's avatar Christian Evenhuis
Hide whitespace changes
Inline Side-by-side
organising_data/Using-naming-conventions.md
View page @ 83bae81e
[Up: Organising data](./Organising-data)
A good naming convention helps keep your data organised. Some scripts have added to OMERO to help extract metadata from file names as [key-values](./key-value_pairs.md) pairs.
A good naming convention helps keep your data organised. Some scripts have added to OMERO to help extract metadata from file names as [key-values](Key-value-pairs.md) pairs.
Key-value pairs are a very flexible way to record the meta data associated with your data. OMERO has powerful searching functions that allow you search the metadata attached to the files.
### Naming conventions
1. Don't use whitespace.
2. Record the import variables (values) in the file name
3. Separate metadata (values) in filenames or directory by an underscore (`_`)
1. Don't use whitespace.
2. Record the important variables (values) in the file name
3. Separate metadata (values) in filenames or directories by an underscore (`_`)
4. You can use directory structure to organise your data, the management of this is a little more complicated though.
### Guidelines
There are no specific rules how to name your files. Whatever system you choose to use, they must be detailed enough that some from your research group could take your lab book and identify each image.
There are no specific rules how to name your files. Whatever system you choose to use, they should be detailed enough that someone from your research group could take your lab book and identify what each image is.
* **More detail is better:** Adding some hints, like `time` or `cell-line` makes it easier for you, and others, to at a glance work out what the naming system means.
* **Too much detail is bad:** Really long filenames are annoying to type, have more chance of typos and can cause issues for Windows.
* **Too much detail is bad:** Really long filenames are annoying to type and have higher chance of typos. If the names get really Windows can't deal them.
* **Directories can help:** You may prefer to organise your data into directories. This helps to reduce input errors. After importing to OMERO there are some scripts that add the directories to the filename.
......