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

Change copyright/release numbers

Browse source
This commit is contained in:
Thomas A. Christensen II 2021-06-18 13:26:35 -05:00
parent 0de4b7dc0c
commit 6573492bac
Signed by: millironx
GPG key ID: 139C07724802BC5D
2 changed files with 42 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

77
README.md
View file

@ -13,35 +13,34 @@ Why? It's part of my effort to
## Installation ## Installation
1. [Download and install Julia](https://julialang.org/downloads/platform/) 1. [Download and install Julia](https://julialang.org/downloads/platform/)
2. Open a new Julia window and type the `]` key 2. Download the [beefblup ZIP
3. Type `add XLSX Gtk` and press **Enter** file](https://github.com/MillironX/beefblup/archive/refs/tags/v0.2.zip) and unzip it someplace memorable
3. In your file explorer, copy the address of the "beefblup" folder
Alternatively, you can run the [install 4. Launch Julia
script](https://github.com/MillironX/beefblup/raw/master/Julia/install.jl) from 5. Type `cd("<the address copied in step 5")` and press **Enter** (For example,
Julia. `cd("C:\Users\MillironX\Documents\beefblup")`)
6. Type the `]` key
7. Type `activate .` and press **Enter**
8. Type `instantiate` and press **Enter**
9. Installation is done: you can close the Julia window
## How to Use ## How to Use
> **Note:** beefblup and [Juno](https://junolab.org)/[Julia Pro](https://juliacomputing.com/products/juliapro.html) currently [don't get along](https://github.com/JunoLab/Juno.jl/issues/118). 1. Make a copy of the "sample.csv" spreadsheet and replace the data with your own
> Although it's tempting to just open up beefblup in Juno and press the big play 1. The trait you wish to calculate EBVs for always goes in the rightmost column
> button, it won't work. Follow these instructions until it's fixed. If you 2. If you wish to add more contemporary group traits to your analysis, include them before the rightmost column
> don't know what Juno is: ignore this message. 2. Save and close
3. In your file explorer, copy the address of the "beefblup" folder
1. Download the [beefblup ZIP 4. Launch Julia
file](https://github.com/MillironX/beefblup/archive/v0.1.zip) and unzip it 5. Type `cd("<the address copied in step 5")` and press **Enter** (For example,
someplace memorable `cd("C:\Users\MillironX\Documents\beefblup")`)
2. Make a copy of the "Master BLUP Worksheet" and replace the sample data with your own 6. Type the `]` key
3. If you wish to add more contemporary group traits to your analysis, replace 7. Type `activate .` and press **Enter**
or add them to the right of the Purple section 8. Press **Backspace**
4. Save and close 9. Type `include("src/beefblup.jl")` and press **Enter**
5. In your file explorer, copy the address of the "Julia" folder 10. Select the spreadsheet you created in steps 1-4
6. Launch Julia 11. Follow the on-screen prompts
7. Type `cd("<the address copied in step 5")` and press **Enter** (For example, 12. **#KeepEPDsReal!**
`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 ## For Programmers
@ -51,19 +50,19 @@ Julia.
### Development Roadmap ### Development Roadmap
| Version | Feature | | Version | Feature | Status |
| ------- | ------------------------------------------------------------------- | | ------- | ----------------------------------------------------------------------------------- | ------------------ |
| v0.1 | Julia port of original MATLAB script | | v0.1 | Julia port of original MATLAB script | :heavy_check_mark: |
| v0.2 | Spreadsheet format redesign | | v0.2 | Spreadsheet format redesign | :heavy_check_mark: |
| v0.3 | API rewrite (change to function calls and package format instead of script running) | | v0.3 | API rewrite (change to function calls and package format instead of script running) | |
| v0.4 | Add GUI for all options | | v0.4 | Add GUI for all options | |
| v0.5 | Automatically calculated Age-Of-Dam, Year, and Season fixed-effects | | v0.5 | Automatically calculated Age-Of-Dam, Year, and Season fixed-effects | |
| v0.6 | Repeated measurement BLUP (aka dairyblup) | | v0.6 | Repeated measurement BLUP (aka dairyblup) | |
| v0.7 | Multiple trait BLUP | | v0.7 | Multiple trait BLUP | |
| v0.8 | Maternal effects BLUP | | v0.8 | Maternal effects BLUP | |
| v0.9 | Genomic BLUP | | v0.9 | Genomic BLUP | |
| v0.10 | beefblup binaries | | v0.10 | beefblup binaries | |
| v1.0 | [Finally, RELEASE!!!](https://youtu.be/1CBjxGdgC1w?t=282) | | v1.0 | [Finally, RELEASE!!!](https://youtu.be/1CBjxGdgC1w?t=282) | |
### Bug Reports ### Bug Reports

8
src/beefblup.jl
View file

@ -6,7 +6,7 @@ exec julia --project=$(realpath $(dirname $(dirname "${BASH_SOURCE[0]}"))) "${BA
# Main script for performing single-variate BLUP to find beef cattle # Main script for performing single-variate BLUP to find beef cattle
# breeding values # breeding values
# Usage: julia beefblup.jl # Usage: julia beefblup.jl
# (C) 2020 Thomas A. Christensen II # (C) 2021 Thomas A. Christensen II
# Licensed under BSD-3-Clause License # Licensed under BSD-3-Clause License
# cSpell:includeRegExp #.* # cSpell:includeRegExp #.*
# cSpell:includeRegExp ("""|''')[^\1]*\1 # cSpell:includeRegExp ("""|''')[^\1]*\1
@ -19,8 +19,8 @@ using Dates
using Gtk using Gtk
# Display stuff # Display stuff
println("beefblup v 0.1") println("beefblup v 0.2")
println("(C) 2020 Thomas A. Christensen II") println("(C) 2021 Thomas A. Christensen II")
println("https://github.com/millironx/beefblup") println("https://github.com/millironx/beefblup")
print("\n") print("\n")
@ -218,7 +218,7 @@ traitname = names(data)[end]
# Start printing results to output # Start printing results to output
fileID = open(savepath, "w") fileID = open(savepath, "w")
write(fileID, "beefblup Results Report\n") write(fileID, "beefblup Results Report\n")
write(fileID, "Produced using beefblup for Julia (") write(fileID, "Produced using beefblup (")
write(fileID, "https://github.com/millironx/beefblup") write(fileID, "https://github.com/millironx/beefblup")
write(fileID, ")\n\n") write(fileID, ")\n\n")
write(fileID, "Input:\t") write(fileID, "Input:\t")