Closed solnavss closed 3 years ago
In addtion to Sol comments, I think it would be useful if you could attend the following comments:
README:
Pdis
, Nit
and CN
? but also even the obvious ones, like Mg
and Na
, should be explained. When relevant, include in this short explanation what are the units.Repo organization:
network_df.csv
. Either mention or delete them.Scripts:
amptk_for_illumina.sh
name the steps as in AMPtk_pipeline.md
so that it is easier to follow both documents together.1_Filter_otu_table.R
line 251: your comment says "multiply by 1000" but the code line doesn't seem to do this. Also, explain how you chose this number to multiply.2_Juniperus_Alpha_Diversity.R
needs clearer documentation (comments). Also, either there or somewhere in the README explain what does the acronyms of the Trophic category mean. 3_Juniperus_Beta_Diversity.R
needs clearer documentation. There are several steps that need to be briefly commented so that anyone can follow what are you doing and why.Hi, I have some comments that I hope will help you to improve your repo:
* [ ] Add open-source license (https://choosealicense.com/) * [ ] Add more references in the Introduction * [x] Separate the code that belongs to the networks analysis from the script "3_Juniperus_Beta_Diversity.R"
Hi Marisol @solouli About item number 1 on the list. Could you explain a bit, I am confused about the type of license I would need? These are data that will soon be sent to try to get them published, so I am unsure. I do want to share the code.
Hi, Ana @bc-anaisabel The goal of the task is for you to check all the license types that exist for different projects. In my opinion, the most appropriate license, since we have code and want to share it but keeping copyright is MIT's. "The MIT License is short and to the point. It lets people do almost anything they want with your project, like making and distributing closed source versions", you can read about it here. I believe the issue with the "soon to be published data" is independent if you are referencing the authors to get access or the other case if you reference the database (Eg. Genbank).
Thank you @solouli. I reviewed the license types but to be honest I don't quite get all of them. I can see how the MIT one could fit this type of project though. However I noticed the pipeline I used to obtain my clean data has a github repo with a license already, since much of this had not been possible without that part I am using their same license. But again not sure if this is how it should work. I'll ask on class either way. Thanks!
Hi, I have some comments that I hope will help you to improve your repo: