๐ŸŒ AIๆœ็ดข & ไปฃ็† ไธป้กต
Skip to content
This repository was archived by the owner on Mar 7, 2023. It is now read-only.

asthmacollaboratory/asthmacollab-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

1 Commit
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Asthma Collaboratory Project Template

This repository contains a barebones framework for analyses and tutorials from the Asthma Collaboratory.

Directory structure

The initial directory structure is shown below. Feel free to adapt it to your needs.

โ”œโ”€โ”€ LICENSE            # defaults to GPL v3
โ”œโ”€โ”€ README.md          # a top-level README for developers using this project
โ”œโ”€โ”€ DESCRIPTION        # a package header for R (not useful otherwise) 
โ”œโ”€โ”€ .gitignore         # all files that Git should _not_ commit 
โ”œโ”€โ”€ .travis.yaml       # build configuration for TravisCI 
โ”œโ”€โ”€ run_analysis.sh    # user-friendly button to push for running all analysis steps 
โ”œโ”€โ”€ env.sh             # a template script for seeding environment variables; save as ".env" 
โ”‚
โ”œโ”€โ”€ analysis
โ”‚   โ”œโ”€โ”€ bin            # any binaries (downloaded, softlinked, or otherwise) for the project 
โ”‚   โ”œโ”€โ”€ data           # all data necessary for project 
โ”‚   โ”œโ”€โ”€ results        # a folder for all analysis results 
โ”‚   โ””โ”€โ”€ figures        # generated graphics and figures to be used in reporting
โ”‚
โ”œโ”€โ”€ docs               # a place to store documentation (Sphinx, Jupyter notebooks, etc.) 
โ”‚
โ”œโ”€โ”€ src                # all source code for the analysis, with 1 folder per step 
โ”‚   โ”œโ”€โ”€ 01_step1    
โ”‚   โ”‚   โ””โ”€โ”€ 01_run_step1.sh 
โ”‚   โ”œโ”€โ”€ 02_step2
โ”‚   โ”‚   โ””โ”€โ”€ 01_run_step2.sh # notice that each substep of a step is ordered numerically starting from 1 
โ”‚   โ”œโ”€โ”€ 03_step3 
โ”‚   โ”‚   โ””โ”€โ”€ 01_run_step3.sh 

About

A template repository for Burchard Lab projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages