Browse Source

git-annex in jcolomb@MacBook-Pro-4

julien colomb 3 years ago
parent
commit
593366549b
4 changed files with 39 additions and 51 deletions
  1. 0 8
      .log/gin.log
  2. 1 1
      04_data_analysis
  3. 38 0
      README-Rrepo1.md
  4. 0 42
      old_sync

+ 0 - 8
.log/gin.log

@@ -1,8 +0,0 @@
-: Sync script executed
-Error occurred during 'gin sync'
-: Sync script executed
-Error occurred during 'gin sync'
-: Sync script executed
-: Sync script executed
-: Sync script executed
-: Sync script executed

+ 1 - 1
04_data_analysis

@@ -1 +1 @@
-Subproject commit aad43a8a621c3c16e90ed6b3845ac9d98d005f3d
+Subproject commit 64cdee6597dc0604ac474f2970e58a9d8cb09ce2

+ 38 - 0
README-Rrepo1.md

@@ -0,0 +1,38 @@
+# This repository follows the Research repository template, v.2.1, https://doi.org/10.5281/zenodo.3987767.
+
+# Project description
+
+### Abstract:
+
+### list of experiments :
+
+### Contribution
+
+Please use the issue tracking on the gin repository to give feedback.
+
+
+
+
+
+# Cheatsheets about what goes where:
+
+- Prior to data acquisition: 
+    - save all documents related to research planning in the 01-Project_management folder, and update material and methods information as soon as possible. For instance, indicate all information about reagents at the time or purchase. And put any code or variable files created for data acquisition in the 02_material_methods folder.
+
+- Data acquisition and analysis: 
+    - Data is organised first following experiments, make sure to describe every experiment in a readme file and link to the adequate files saved in 02_material_methods.
+    - All files coming directly from your hardware should go in the rawdata folder.
+    - Any file that you want to archive or publish should go in the derivateddata folder. This includes results from manual analysis of the raw data.
+    - Any file created automatically during the analysis and that is easy to recreate should be saved in the processed_data folder: it will not be included in the long term storage or publication of the data.
+    - The 04_data_analysis folder should only include code and documentation of the analysis. If you are using excel to analyse the data, put the files in the processed_data and only add some text describing the analysis in the analysis folder.
+    - The output of your analysis (figures and reproducible reports pdfs) should be saved in the 05_figures or the 06_disseminations/01_report_conferences/01_textreports folders, to facilitates sharing with non-coders.
+
+- Manuscript preparation
+    - Put figures ready for publication in the 05_figures/shared_figures folder
+    - Put the manuscript (or some important versions of it, if using an external tool for writing it) in the 06_disseminations/02_manuscripts folder. Please use full URL to embed figures in the manuscript.
+    
+# Notes
+  
+The folder structure is extended following extend_this_tree.md, a file that can be deleted once the repository is in function.
+
+Note: synchronisation scripts will be added when ready.

+ 0 - 42
old_sync

@@ -1,42 +0,0 @@
-#!/usr/bin/env bash
-#
-# Upload changes from inside repository using GIN CLI
-# Assumes no submodules
-# Assumes gin init was performed or the repository was downloaded via gin get
-
-if (( $# > 0 )); then
-    echo "This script takes no arguments"
-    exit 1
-fi
-
-checkerror() {
-    err=$1
-    msg=$2
-    if [[ ${err} != 0 ]]; then
-        echo ${msg} >> ./log/gin.log
-        echo ${msg}
-        echo "Press [Enter] to close this window"
-        read
-        exit 1
-    fi
-}
-
-loc=$(dirname $0)
-projectdir=$(git -C ${loc} rev-parse --show-toplevel)
-
-pushd ${loc} > /dev/null
-
-mkdir -p ./.log
-echo "$(date -Iseconds): Sync script executed" >> ./.log/gin.log
-
-gin sync
-checkerror $? "Error occurred during 'gin sync'"
-gin commit .
-checkerror $? "Error occurred during 'gin commit'"
-gin upload
-checkerror $? "Error occurred during 'gin upload'"
-
-# Uncomment the two lines below to download all large files
-# gin get-content .
-# checkerror $? "Error occurred during 'gin get-content'"
-popd > /dev/null