millironx/beefblup
1
0
Fork 0
mirror of https://github.com/MillironX/beefblup.git synced 2024-11-13 03:03:08 +00:00
Code Issues Releases Packages Activity
Scripts and spreadsheets for performing single-variate Best Linear Unbiased Predictor (BLUP) to find beef cattle breeding values #KeepEPDsReal
71 commits 3 branches 4 tags 440 KiB
Julia 100%
Find a file
Thomas A. Christensen II de0eb6f5a9
Fix spell checking so I can focus on real problems
2021-06-18 12:05:55 -05:00
.github/ISSUE_TEMPLATE Update issue templates 2020-03-05 20:56:44 -08:00
data Reformat spreadsheet 2021-01-04 02:24:39 -07:00
src Fix spell checking so I can focus on real problems 2021-06-18 12:05:55 -05:00
.gitattributes Added git meta files to avoid corruption 2018-09-07 09:20:01 -06:00
.gitignore Add Julia stuff to gitignore 2020-02-15 20:13:37 -08:00
CODE_OF_CONDUCT.md Add code of conduct 2020-10-11 20:51:43 -06:00
LICENSE Create Github-template LICENSE file 2020-10-11 21:24:56 -06:00
Project.toml Switch to Julia's package install method 2021-06-18 10:42:12 -05:00
README.md Fix download link 2020-10-11 20:53:34 -06:00

README.md

[🐮]: beefblup

GitHub license Join the chat at https://gitter.im/beefblup/community Github all releases

beefblup is a program for ranchers to calculate expected breeding values (EBVs) for their own beef cattle. It is intended to be usable by anyone without requiring any prior knowledge of computer programming or linear algebra. Why? It's part of my effort to #KeepEPDsReal

Installation

  1. Download and install Julia
  2. Open a new Julia window and type the ] key
  3. Type add XLSX Gtk and press Enter

Alternatively, you can run the install script from Julia.

How to Use

Note: beefblup and Juno/Julia Pro currently don't get along. Although it's tempting to just open up beefblup in Juno and press the big play button, it won't work. Follow these instructions until it's fixed. If you don't know what Juno is: ignore this message.

  1. Download the beefblup ZIP file and unzip it someplace memorable
  2. Make a copy of the "Master BLUP Worksheet" and replace the sample data with your own
  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. Save and close
  5. In your file explorer, copy the address of the "Julia" folder
  6. Launch Julia
  7. Type cd("<the address copied in step 5") and press Enter (For example, cd("C:\Users\MillironX\Documents\beefblup\Julia"))
  8. Type include("beefblup.jl") and press Enter
  9. Select the spreadsheet you created in steps 1-4
  10. Follow the on-screen prompts
  11. #KeepEPDsReal!

For Programmers

Also Note: beefblup was written on, and has only been tested with Julia v1.2.0 and higher. While this shouldn't affect most everyday users, it might affect you if you are stuck on the current LTS version of Julia (v1.0.5).

Development Roadmap

Version Feature
v0.1 Julia port of original MATLAB script
v0.2 Spreadsheet format redesign
v0.3 API rewrite (change to function calls and package format instead of script running)
v0.4 Add GUI for all options
v0.5 Automatically calculated Age-Of-Dam, Year, and Season fixed-effects
v0.6 Repeated measurement BLUP (aka dairyblup)
v0.7 Multiple trait BLUP
v0.8 Maternal effects BLUP
v0.9 Genomic BLUP
v0.10 beefblup binaries
v1.0 Finally, RELEASE!!!

Bug Reports

For every bug report, please include at least the following:

  • Platform (Windows, Mac, Fedora, etc)
  • Julia version
  • beefblup version
  • How you are running Julia (From PowerShell, via the REPL, etc.)
  • A beefblup spreadsheet that can be used to recreate the issue
  • Description of the problem
  • Expected behavior
  • A screenshot and/or REPL printout

License

Distributed under the 3-Clause BSD License