Open AngryMaciek opened 3 years ago
Also: people generally include their colorful GH shields on top of the README file, they are very attractive ;)
I would suggest to move the zenodo example data shield to the top and later in the text just use a link with a URL. Also, it would be nice to upload the repo itself to zenodo! Nothing wrong with having two zenodo shields on top.
I would suggest a few changes to the repo structure to conform with what is usually available:
resources
and put go_annotations insidetest
scripts
; the script would download theh5ad
files from zenodo automatically and put them undertest/data
.theta_annotation
a resource or an example input? It should be put either underresources
or undertest
. Should this go together with the go annotations(?)DeepCycle.py
is a script so it should go underscripts
too.environment.yml
(instead ofDeepCycle_env.yml
). Then you can just runconda env create
and the package manager automatically looks forenvironment.yml
file. The env will still retain the name specified within the YAML file.