整體思想:
(1)機(jī)器可讀
(2)人可讀
(3)排序與默認(rèn)排序類似
部分原則:
(1)名字不帶空格
(2)最好不大小寫敏感宾舅,所有文件都轉(zhuǎn)換成大寫或者小寫后薪鹦,不能有重名文件若厚;
(3)連字符采用統(tǒng)一標(biāo)準(zhǔn)裙士,例如心剥,下劃線(_)表示part征堪,而中短橫線(-)表明這是一個(gè)part瘩缆,例如多個(gè)單詞的名字;
Tips for naming:
思考你的文件佃蚜,想想你的文件是關(guān)于什么的庸娱?
- 你的文件命名可以涵蓋哪些文件組(group);
- 對(duì)于不同的文件集可以使用不用的命名規(guī)格
- 檢查你的研究組和研究學(xué)科里中已經(jīng)建立的命名規(guī)則
例如谐算,建立一個(gè)可以描述所有顯微圖片的命名規(guī)范熟尉,包含了原始圖片和加工后的圖片。
檢查metadata洲脂,例如時(shí)間斤儿、樣本、實(shí)驗(yàn)恐锦,思考如何簡(jiǎn)單快速的定位特定文件需要什么信息
電腦根據(jù)文件名進(jìn)行排序(字母順序)往果,因此,最重要的信息要放到最前面一铅,例如陕贮,你預(yù)計(jì)你要根據(jù)日期找文件,則把日期寫在最前面
- 文件名應(yīng)該具有描述性并且提供足夠的內(nèi)容信息潘飘。
例如肮之,可以將下面的信息結(jié)合起來:
實(shí)驗(yàn)條件
數(shù)據(jù)類型
研究者
實(shí)驗(yàn)室名字
項(xiàng)目名字 - 實(shí)驗(yàn)室日期或者范圍(range),例如使用YYYYMMDD卜录,這樣可以使得文件具有編年史順序局骤。未來加入時(shí)間戳,可以使用YYYYMMDDThhmm暴凑,即通過T進(jìn)行時(shí)間隔斷。
- 實(shí)驗(yàn)號(hào)或者樣品號(hào)
對(duì)于連續(xù)編號(hào)系統(tǒng)赘来,使用前導(dǎo)的0作為起始现喳,來確保清晰和保證文件處于正確的序列凯傲。應(yīng)該使用"001, 002, ...010, 011 ... 100, 101 ..." 而不是 "1, 2, ...10, 11 ... 100, 101 ..."
簡(jiǎn)寫或者metadata編碼
不要忘記文件編碼格式!
決定哪些短短信息被保留
標(biāo)準(zhǔn)化類別和/或用2或3個(gè)字母的代碼替換它們
確保記錄這些編碼信息
例子:
Project id使用2個(gè)字符嗦篱,p1冰单,p2
物種id用三個(gè)字符,mouse=MUS灸促, fruit fly=DRS
樣本id用三個(gè)字符诫欠;
使用版本號(hào)
你是否需要維持對(duì)于同一文件維持不同版本號(hào)
使用版本管理來表明文件的最新版本
通過在文件名的末尾添加版本信息來跟蹤文件的版本,例如:文件名_v2.xxx
使用版本號(hào)(例如:"v01 "或 "v02")浴栽。
使用版本日期(使用ISO 8601格式:YYYMMDD或YYY-MM-DD)荒叼。
思考你如何搜索你的文件
對(duì)于metadata和文件的排序,思考你想如何排序和搜索你的文件典鸡;
決定metadata如何出現(xiàn)在開始
使用默認(rèn)的排序:字母 數(shù)字 日期
使用ISO 8601-formatted dates (YYYYMMDD or YYYY-MM-DD)
分隔metadata數(shù)據(jù)
文件名中避免使用空格和特殊字符被廓,因?yàn)楹芏嚯娔X系統(tǒng)并不能很好的處理帶有空格的文件名,所以不要使用空格萝玷!
? 使用 dashes (-), underscores (_)嫁乘,或者每個(gè)單詞的首字母大寫
? Dashes: file-name.xxx
? Underscores: file_name.xxx
? No separation: filename.xxx(介詞一般不大寫,例如in of)
? 使用駝峰標(biāo)記 (每個(gè)部分的首字母大寫): FileName.xxx
? 避免使用特殊字符球碉,例如: ~ ! @ # $ % ^ & * ( ) ` ; : < > ? . , [ ] { } ' " |
寫下你的命名規(guī)則
同時(shí)蜓斧,也應(yīng)在最頂層寫一個(gè)README文件來描述你的文件結(jié)構(gòu);
? 如果文件被移動(dòng)了或者被分享了睁冬,使用者應(yīng)該能通過文件名識(shí)別該文件挎春;
? 文件名應(yīng)該只使用字母,短橫線痴突,下劃線搂蜓,一般少于50字符
? 如果你發(fā)現(xiàn)文件名中編碼了大量metadata,那么你應(yīng)該考慮將這些元數(shù)據(jù)與你的數(shù)據(jù)一起存儲(chǔ)在主表格中辽装,以便將來參考帮碰。
例如:我的文件命名格式為
[SA-MPL-EID][YYYYMMDD][###]_[status].[tif]
參考:
https://datamanagement.hms.harvard.edu/collect/file-naming-conventions