> For the complete documentation index, see [llms.txt](https://gitbook.bergelsonlab.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.bergelsonlab.com/archive/duke-archive/programming-ra-log.md).

# Programming RA log

Up to date information on who's working on what and where

### Instructions

Every information on what you are working on should be found here. The goal is that anybody can pick up your project from where you left it, at anytime; therefore, it is necessary that:

* &#x20;the **current version** of the code you are using is **available at all time** (ie pushed on indicated git repository at the end of each of your working sessions)
* &#x20;there is a **README.md** in the git repo, with instructions on **how to run each of your scripts** as well as what each script does and on what data it should be applied (give a full example)
* the data you are using as input is accessible as well: either **give the exact** **path of the input data** or indicate the paths you use as input parameters
* the output of your code is available even without running the scripts: this means that the output should be located somewhere on the cloud storage, as you probably don't want to push it to any repo

{% hint style="info" %}
Each chunk of code that you use has to be available on a git repository with corresponding information in the README.md.
{% endhint %}

{% hint style="info" %}
Nothing should be available only locally (either personal computer or lab computer): store the output in a dedicated directory on cloud storage.&#x20;

The best option would be to have the following setup: there is an instance of the git repo you are working on in Scripts\_and\_apps, in which there is an output folder (don't forget to add that folder in the .gitignore).
{% endhint %}

{% hint style="info" %}
If one of the categories does not apply, please explain why and where to find more information.&#x20;
{% endhint %}

### Log

{% tabs %}
{% tab title="Name" %}
**Project you are working on**:&#x20;

* [ ] Description
*
* [ ] Todo list:
*
*
* [ ] Notes/further information:
*

&#x20;  \*

{% endtab %}
{% endtabs %}

###
