Browse Source

update readme

julien colomb 4 years ago
parent
commit
2367f2e22f
1 changed files with 4 additions and 3 deletions
  1. 4 3
      README.md

+ 4 - 3
README.md

@@ -8,13 +8,14 @@ Note that the 10_rawdata folder will be published upon publication, with or inde
 
 If any file related to the project is stored outside of this repository, please indicate links here.
 
-FAQ:
-What are derived and raw data?
+#FAQ
+
+## What are derived and raw data?
 
 > In theory, data that can be derived from another dataset during the analysis is called derived data.In practice here, raw data is what will be stored long term, derived data will be trashed once the paper is published and we need the room. Because it becomes more costly to store the data (> 10 years) than to reproduce it, derived data are normally not stored. Note that if the derived data is small but the computing time to produce it is large (for example with video analysis producing a spreadsheet file), it is advised to put that dataset in the 10_rawdata folder.
 
 > Strickly speaking, raw data can be analog (notes on paper for instance), but qhat we call raw data here is the first digital version of the data you collected (in theory it can be picture of personal notes, stricly speaking it should be called primary data). It is good practice to document data provenance in order to be able to get back to the raw data (especially if it is not digital), if anything has to be changed in the analysis. 
 
-I am not using code ?
+## I am not using code ?
 
 > please then describe your analysis using words. The point is that the analysis can be performed again, by somebody else than yourself. That information would be better suited in the 40_notebook folder.