search

comorment / gwas

GNU General Public License v3.0
4 stars 1 forks source link

Move this git repo to its permanent location #2

Closed ofrei closed 3 years ago

ofrei commented 4 years ago

I don't have strong opinion about where this should go, feel free to decide. This could be https://github.com/comorment , to highlight that these tools are developed as part of comorment. Or this could be in your own github account, i.e. https://github.com/bayramakdeniz/gwas . I think keeping under your account also helps to promote your package on github, because people trust that you are responsible for maintaining it. This is how it's done for plink ( https://github.com/chrchang/plink-ng/ ).

My only suggestion is to have a short name (i.e. https://github.com/bayramakdeniz/gwas ), don't use underscores, and only use lowercase in the repo name.

ofrei commented 3 years ago

After many back-and-force thoughts about which github repositories to use, I think most convenient option for development would be to place all containers (gwas, ldsc, demo, matlab-octave, and future containers) in this repository (https://github.com/comorment/gwas), and also keep here all README files. Folder structure can be, for example, as follows:

scripts/      # instal_***.sh and other shell scripts 
containers/demo/    # Dockerfile for DEMO container, including it's README file (users instructions) and CONTRIBUTING file (info  for other developers, but not essential for users)
containers/gwas/
containers/ldsc/
containers/matlab/
docs/         # more detailed documentation (I think container-specific README files may link here for more details).
README.md   # root level README.md listing all available containers, and links to individual README files
ofrei commented 3 years ago

Some of this is done here #20