millironx/beefblup
1
0
Fork 0
mirror of https://github.com/MillironX/beefblup.git synced 2024-12-22 17:08:16 +00:00
Code Issues Releases Packages Activity

Update README.md

Browse source
This commit is contained in:
Thomas A. Christensen II 2019-09-28 00:20:02 -07:00 committed by GitHub
parent 2b0c5bb54f
commit 5f3d54e86d
1 changed files with 27 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -1,5 +1,7 @@
# beefblup
:cow: :cow: :cow:
#### \#KeepEPDsReal
MATLAB and Python scripts and Excel spreadsheets that can be used in conjunction to find breeding values for beef cattle.
@ -8,7 +10,7 @@ MATLAB and Python scripts and Excel spreadsheets that can be used in conjunction
1. Choose a spreadsheet appropriate to the trait you want to analyze from the `Excel` folder, and save it to your hard drive
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, replace or add them to the right of the Purple section
4. Download the entire `MATLAB` folder, and set it as your current MATLAB directory
5. Run `beefblup.m`
6. Select the spreadsheet file you just placed your data into
@ -17,20 +19,36 @@ MATLAB and Python scripts and Excel spreadsheets that can be used in conjunction
## Contributing
I will gladly take input on the following:
I will gladly accept pull requests that acomplish any of the following:
* Converting MATLAB scripts to Python
* Convert MATLAB scripts to Python
* The product must be able to be run from the native (non-python) terminal using only the default [Anaconda Python packages](https://anaconda.com/distribution)
* Optimizing code sections
* Adding spreadsheets for additional traits
* Bug reports, usability issues, etc.
* Use triagonal shortcuts to generate the additive relationship matrix
* Solve implicit forms of the mixed-model equation
* Perform cannonical transformations for missing values
* Other similar improvements that I might not be aware of
* Creation of scripts to handle additional forms of BLUP
* Mult-trait (MBLUP)
* Maternal-trait
* Genomic-enhanced (GBLUP) - this will require the creation of a standard SNP spreadsheet format
* Creation of spreadsheets for additional traits
* Creation of wiki pages to explain what each script does
* The general rule is that **every** wiki page should be understandable to anyone who's passed high school algebra, while still being correct and informative
If you are writing code, please keep the code clean by:
* Indenting using the native editor's formating
* 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)
Note that I intend to implement all of the items above eventually, but progress is slow since I'm learning as I go.
If you are writing code, please keep the code clean:
* Run "Smart Indent" in the MATLAB editor on the entire file before checking it in
* Name variables in full word English using all lowercase, 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
* Comments go before a code block: no inline comments
Bug reports and suggestions will be gladly taken on the [issues](https://github.com/MillironX/beefblup/issues) page. There is no set format for issues, yet, but please at the minimum attach a filled-out spreadsheet that demonstrates your bug or how your suggestion would be useful.
## License
Distributed under the 3-Clause BSD License