millironx/beefblup
1
0
Fork 0
mirror of https://github.com/MillironX/beefblup.git synced 2024-09-20 21:12:03 +00:00
Code Issues Releases Packages Activity

Updated README.md

Browse source
This commit is contained in:
Thomas A. Christensen II 2018-11-13 15:51:40 -07:00
parent da5397e4f9
commit 0ba6bae677
1 changed files with 3 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -4,9 +4,7 @@ MATLAB and Python scripts and Excel spreadsheets that can be used in conjunction
## How to Use ## How to Use
*Notice: this project is currently in development, these instuctions are to guide development efforts toward an intended operation procedure* 1. Choose a spreadsheet appropriate to the trait you want to analyze from the `Excel` folder, and save it to your hard drive
1. Choose a spreadsheet appropriate to the trait you want to analyse from the `Excel` folder, and save it to your hard drive
2. Place your data into the structure described by the spreadsheet 2. Place your data into the structure described by the spreadsheet
3. If you wish to add more contemporary group traits to your analysis, add them into or directly after the Purple section 3. If you wish to add more contemporary group traits to your analysis, add them into or directly after the Purple section
4. Download the entire `MATLAB` folder, and set it as your current MATLAB directory 4. Download the entire `MATLAB` folder, and set it as your current MATLAB directory
@ -17,7 +15,7 @@ MATLAB and Python scripts and Excel spreadsheets that can be used in conjunction
## Contributing ## Contributing
I will not accept any contributions while writing the initial MATLAB script. Once that is finished, I will gladly take input on the following: I will gladly take input on the following:
* Converting MATLAB scripts to Python * Converting MATLAB scripts to Python
* Optimizing code sections * Optimizing code sections
@ -27,7 +25,7 @@ I will not accept any contributions while writing the initial MATLAB script. Onc
If you are writing code, please keep the code clean by: If you are writing code, please keep the code clean by:
* Indenting using the native editor's formating * Indenting using the native editor's formating
* Naming variables in full word English using camelCase, unless the matrix name is generally agreed upon in papers (i.e. A is the additive relationship matrix) * Naming variables in full word English using all lowercase for MATLAB and camelCase for Python, unless the matrix name is generally agreed upon in academic papers (i.e. A is the additive relationship matrix)
* For MATLAB, functions go in a separate file * For MATLAB, functions go in a separate file
* Comments go before a code block: no inline comments * Comments go before a code block: no inline comments