diff --git a/2019/2019-06-25_file-naming/slides/final-notes.md b/2019/2019-06-25_file-naming/slides/final-notes.md new file mode 100644 index 0000000000000000000000000000000000000000..8c8fa5c808244ef37f8c9250f773b7cbccb2aba3 --- /dev/null +++ b/2019/2019-06-25_file-naming/slides/final-notes.md @@ -0,0 +1,10 @@ + +# Final notes + +* plan ahead + +* follow guidelines of your team + +* ensure proper dissemination of your naming policy + +* consistency overrules personal preference diff --git a/2019/2019-06-25_file-naming/slides/human_readable.md b/2019/2019-06-25_file-naming/slides/human_readable.md index b2a53d2d4a7634e2525e019f9c52522d8377cab5..5925fa7c47dab3f8c6f5dbbc7058f2ed627389a5 100644 --- a/2019/2019-06-25_file-naming/slides/human_readable.md +++ b/2019/2019-06-25_file-naming/slides/human_readable.md @@ -2,12 +2,15 @@ ## Human readable name carries information about content * use English -* balance length against clarity + +* balance name length against clarity + * don't be too creative and stay professional +<!-- "PEPA_d-pic.jpeg" - a fourth **pic**ture from your paper on **P**erformance **E**valuation **P**rocess **A**lgebra --> - "PEPA_d-pic.jpeg" - a fourth **pic**ture from your paper on **P**erformance **E**valuation **P**rocess **A**lgebra * **never** use suffixes (or prefixes) like **"final"**, **"old"**, **"new"**, **"current"**, **"obsolete"**, **"recent"**, **"latest"**, **"best"**... + * leave out meaningless words, e.g. "the", "and", "a", "file", "data" ... @@ -25,7 +28,7 @@ name carries information about content | Bad named | Better name | | ------------------------- | ----------------------------------------------------- | -| myabstract.txt | John_White-Sensitivity_of_PLFA_analyses-abstract.txt | -| samples_project_start.csv | PA324-samples_2019-12-11.csv | -| ms_cresp_final.doc | John_White-Cell_respiration-manuscript-2019-12-11.doc | -| fig_1.png | John_White-Cell_respiration-fig_1-2019-12-11.png | +| myabstract.txt | John-White_Sensitivity-of-PLFA-analyses_abstract.txt | +| samples_project_start.csv | PA324_samples_2019-12-11.csv | +| ms_cresp_final.doc | John-White_Cell-respiration_manuscript_2019-12-11.doc | +| fig_1.png | John-White_Cell-respiration_fig-1_2019-12-11.png | diff --git a/2019/2019-06-25_file-naming/slides/list.json b/2019/2019-06-25_file-naming/slides/list.json index db34e3b054a8b0a83482a357abaf2e6b4e1c2874..27401c43be2b70861bb79aefb29a29b6f80b2b8b 100644 --- a/2019/2019-06-25_file-naming/slides/list.json +++ b/2019/2019-06-25_file-naming/slides/list.json @@ -4,11 +4,6 @@ "attr": { } }, - { - "filename": "overview.md", - "attr": { - } - }, { "filename": "three_principles.md", "attr": { @@ -30,7 +25,7 @@ } }, { - "filename": "take_away.md", + "filename": "final-notes.md", "attr": { } }, diff --git a/2019/2019-06-25_file-naming/slides/machine_readable.md b/2019/2019-06-25_file-naming/slides/machine_readable.md index dbf5a033b069546eb724f36c3f0ed233015b9673..c4a4dd3b5afda0312b1bf3aa957f5dc1d568f58a 100644 --- a/2019/2019-06-25_file-naming/slides/machine_readable.md +++ b/2019/2019-06-25_file-naming/slides/machine_readable.md @@ -3,15 +3,15 @@ * case sensitivity -* special characters: +* <span style="color:red">special characters</span>: **#$%&'(")*+, -./:;<=>?@[\ ]^_`{|}~** and white characters like **space** or **tabulator** -* accented characters: +* <span style="color:red">accented characters</span>: **ç**, **ä**, **ô**, **ě**, **ŕ**, ... -* lack of consistency: +* <span style="color:red">lack of consistency</span>: ``` 2013-06-26_BRAFWTNEGASSAY_Plasmid-Cellline-100-1MutantFractions_B03.csv 2013-06-26_BRAFWTNEGASSAY_Plasmid-Celline-100-1MutantFraction_B03.csv @@ -29,22 +29,22 @@ So what should I use? * underscore "**_**" to separate Example: -``` -projectID_method-name_sampleID_YYYY-MM-DD.ext -Author-Name_Paper-Name_manuscript_YYYY-MM-DD.doc -``` + +"projectID_method-name_sampleID_YYYY-MM-DD.ext" +"Author-Name_Paper-Name_manuscript_YYYY-MM-DD.doc" + # Machine readable -Real **ugly** names: +**Ugly** names: ``` "Hlad.jez.M-L-průtoky JÃObj.z OhÅ™e-od 10-2011.xlsx" "Finacial detailes BIocore 19/11/12.xls" "ATACseq1Londonmapped.bam" ``` -Nice names: +**Nice** names: ``` Hipo-1631_CA1_iba-1488_GFAP-647.tiff 2013-06-26_BRAFWTNEGASSAY_Plasmid-Cellline-100-1MutantFraction_A01.csv diff --git a/2019/2019-06-25_file-naming/slides/mySlide.md b/2019/2019-06-25_file-naming/slides/mySlide.md deleted file mode 100644 index 6b422db2fffd3d6ea6529a3f28e2c6f62429004b..0000000000000000000000000000000000000000 --- a/2019/2019-06-25_file-naming/slides/mySlide.md +++ /dev/null @@ -1,4 +0,0 @@ -## mySlide - -0. Subject 1 -1. Subject 2 diff --git a/2019/2019-06-25_file-naming/slides/ordering.md b/2019/2019-06-25_file-naming/slides/ordering.md index 12fbd24cb07ecebcb992ce78a10ee3aa8d8167ad..45f16f73f93189616583196e500f531e1fe7ba06 100644 --- a/2019/2019-06-25_file-naming/slides/ordering.md +++ b/2019/2019-06-25_file-naming/slides/ordering.md @@ -2,9 +2,11 @@ ## Default ordering use of inbuilt ordering -* terms in general-to-specific order - logical ordering +* terms in general-to-specific order - logical ordering +"projectID_method-name_sampleID_YYYY-MM-DD.ext" <!-- TODO --> * date first - chronological ordering + * digits first - explicit ordering @@ -13,8 +15,10 @@ use of inbuilt ordering use of inbuilt ordering * terms in general-to-specific order - logical ordering + <!-- TODO --> * date first - chronological ordering + ``` 2013-06-26_Plasmid_A01.csv 2014-06-26_Plasmid_C02.csv @@ -31,8 +35,10 @@ use of inbuilt ordering use of inbuilt ordering * terms in general-to-specific order - logical ordering + <!-- TODO --> * date first - chronological ordering + * digits first - explicit ordering ``` 01_Plasmid_A01_2013-06-26.csv diff --git a/2019/2019-06-25_file-naming/slides/overview.md b/2019/2019-06-25_file-naming/slides/overview.md deleted file mode 100644 index 5ab544679aacd1eb093a1ca3f63e41b3af42d44b..0000000000000000000000000000000000000000 --- a/2019/2019-06-25_file-naming/slides/overview.md +++ /dev/null @@ -1,4 +0,0 @@ -## Overview - -0. Subject 1 -1. Subject 2 \ No newline at end of file diff --git a/2019/2019-06-25_file-naming/slides/summary.md b/2019/2019-06-25_file-naming/slides/summary.md new file mode 100644 index 0000000000000000000000000000000000000000..1df39553019e440c9f4f5f667b21adc06736e5e9 --- /dev/null +++ b/2019/2019-06-25_file-naming/slides/summary.md @@ -0,0 +1,11 @@ +## Three main principles +* Machine readable: + * easily search for files later + * easily narrow file lists based on names + * easily extract info from file names, e.g. by splitting, regex,... +* Human readable: + * easily understand what the file is and what it contains + * easily share files with others +* Plays well with default ordering: + * logically ordered/clustered + * fast manual search diff --git a/2019/2019-06-25_file-naming/slides/take_away.md b/2019/2019-06-25_file-naming/slides/take_away.md deleted file mode 100644 index 080e7dbdb27f9b5aa39c4df65438ef02e7b3158b..0000000000000000000000000000000000000000 --- a/2019/2019-06-25_file-naming/slides/take_away.md +++ /dev/null @@ -1,2 +0,0 @@ - -# TAKEAWAY diff --git a/2019/2019-06-25_file-naming/slides/three_principles.md b/2019/2019-06-25_file-naming/slides/three_principles.md index e87f25b9bf2eb55ab0fe53b9968b464df880791b..45a4ded2abf8abf2a28ca317aa9872f2a634e282 100644 --- a/2019/2019-06-25_file-naming/slides/three_principles.md +++ b/2019/2019-06-25_file-naming/slides/three_principles.md @@ -5,9 +5,11 @@ * easily search for files later * easily narrow file lists based on names * easily extract info from file names, e.g. by splitting, regex,... + * Human readable: * easily understand what the file is and what it contains * easily share files with others + * Plays well with default ordering: * logically ordered/clustered * fast manual search