Skip to content

An R Package To Read, Process, and Visualize Retriever's Output.

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md
Notifications You must be signed in to change notification settings

bonifazi/labradoR

Repository files navigation

labradoR

R-CMD-check

The goal of the labradoR R package is to facilitate the handling and post-processing in R of the output from Retriever software.

Retriever is a software for retrieving information on population structure, inbreeding, and kinship from pedigrees analysis generating many statistics and plots. For more information on Retriever please refer to the official software website and it associated publication.

labradoR help users to import the output generated by Retriever into R for further manipulation and downstream analyses. labradoR loads the main tabular information into data.frames and generates associated ggplot2 plots objects similar to those of Retriever.

Installation

You can install the development version of labradoR from GitHub with:

# install.packages("devtools")
devtools::install_github("bonifazi/labradoR")

Usage

The below is a basic example showing the package usage. As input, you need to provide the path to the .out file generated by Retriever. Note that the .out file can be in English or in Dutch (depending on the settings used when running Retriever). Both languages are supported: set the needed language using the language argument (ENG for English and DUT for Dutch).

library(labradoR)
## example usage
output <- process_retriever(file_name = "C:/myPath/pedigree_Retriever.out",
 language = "ENG")

str(output, max.levels = 1, give.attr = F)

Note: since the logic of labradoR is that of “fetching” lines from Retriever’s output, if anything changes in the format of the .out file, then labradoR’s associated code will need to be adapted accordingly. Currently, labradoR has been tested and used with Retriever v7 (newer versions and sub-populations are not supported yet).

Example output

You can find an example of the output generated by labradoR here.
Note that this report is just to show the main outputs of the package. Here Retriever was run on a sheep pedigree simulated using MoBPS (code here ). Real pedigrees will likely show much more uneven distributions.

Citation

If you use the labradoR package in your research, please cite it as follows:

  1. Citing the Software

    To cite the software directly, you can use the following format in your work:

  2. Citing the Associated Paper

    A paper is currently in preparation. For now, you can refer to the associated presentation:

    • Winding, J. J., Meuwissen, T. H. E., Croiseau, P., Restoux, G., & Bonifazi, R. (2023). Impact of genomic selection on genetic diversity in five European local cattle breeds. Proceedings of the 74th Annual Meeting of the European Federation of Animal Science, Lyon, France (p. 160).

Contributing

You are welcome to contribute to the development of labradoR.

How to Contribute

  • Feature Requests: If you have a new feature in mind or a suggestion for improvement, please open a GitHub issue to discuss it.

  • Bug Reports: If you encounter any bugs or issues while using labradoR, please submit a bug report with detailed information about the problem.

  • Pull Requests: feel free to fork the repository, make your changes, and submit a pull request.

News and Updates

Check out the NEWS file for the latest updates and changes to the package.

Acknowledgements

About

An R Package To Read, Process, and Visualize Retriever's Output.

Topics

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md

Stars

Watchers

Forks

Packages

No packages published

Languages