GGoutlieR
GGoutlieR: an R package to identify and visualize unusual geo-genetic patterns of biological samples - Published in JOSS (2023)
Science Score: 95.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 5 DOI reference(s) in README and JOSS metadata -
○Academic publication links
-
✓Committers with academic emails
3 of 3 committers (100.0%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Repository
Basic Info
- Host: GitHub
- Owner: kjschmidlab
- License: other
- Language: R
- Default Branch: master
- Size: 11.4 MB
Statistics
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
- Releases: 1
Metadata Files
README.md
GGoutlieR
GGoutlieR (Geo-Genetic outlieR) is an R package for identifying and visualizing unusual geo-genetic patterns for landscape genomic studies.
Outliers with unusual geo-genetic association patterns can be identified through either genetics-based K-nearest neighbors (KNNs) or geography-based KNNs in the framework of GGoutlieR.
It provides a summary table with heuristic p-values allowing users to easily identify outliers from thousands of biological samples. Moreover, its visualization tool enables users to present unusual geo-genetic association patterns on a geographical map.
Details about GGoutlieR framework
To find the detailed algorithm of GGoutlieR, please check the supplementary material of our manuscript HERE (./paper/suppinfo.pdf).
Installation
You can install GGoutlieR either from CRAN or from this Github repository with the R commands below.
```
-----------------------
install from CRAN
-----------------------
install.packages("GGoutlieR")
-----------------------
install from GitHub
-----------------------
install dependencies
install.packages(c("stats4","FastKNN","foreach","doParallel","parallel","scales", "RColorBrewer","ggforce", "rlang", "tidyr", "utils", "rnaturalearth", "rnaturalearthdata", "sf", "ggplot2","cowplot"))
install GGoutlieR from Github
library(devtools) install_git("https://github.com/kjschmidlab/GGoutlieR.git") ```
Get started
You can find a more detailed tutorial with an example of GGoutlieR using a global barley landrace collection HERE (./vignettes/outlier_detection.pdf).
The VCF file of the barley landrace collection is available HERE (./supp_data/IPKbarley_GBS1661landraces_LDpruned.vcf.gz).
Simple example
```
example of barley landrace data
library(GGoutlieR) data("ipkanccoef") # get ancestry coefficients data("ipkgeocoord") # get geographical coordinates
run ggoutlier (takes about 40 sec)
ggoutlierexample <- ggoutlier(geocoord = ipkgeocoord, gencoord = ipkanccoef, makefig = FALSE, pthres = 0.005, cpu = 4, klim = c(3,15), method = "composite", verbose = FALSE, multistages = FALSE) # switch off multi-stage test to reduce computational time
check the first few rows of the summary table
head(summaryggoutlier(ggoutlierexample))
visualize GGoutlieR results (set boundaries using plot_xlim and plot_ylim to focus on Eurasia and North Africa)
plotggoutlier(ggoutlierres = ggoutlierexample, gencoord = ipkanccoef, geocoord = ipkgeocoord, pthres = 0.005, maptype = "both", plotxlim = c(-20,140), plotylim = c(10,62), pierscale = 1.8, mapresolution = "medium") ```
Reference manual
The reference manual is at
https://cran.r-project.org/web/packages/GGoutlieR/GGoutlieR.pdf
Contributing
We appreciate your interest in using GGoutlieR in your study.
You can contribute to the improvement of the package via following ways.
Questions and bug reports
Please open issues if you notice an issue with the GGoutlieR repository.
You can also contact cheweichang92@gmail.com or karl.schmid@uni-hohenheim.de for your questions.
Pull request
If you would like to contribute to the code:
- Fork the
GGoutlieRrepository - Contribute to your forked repository.
- Create a pull request.
Your changes or additions will be merged in the master branch of GGoutlieR repository if they pass required checks.
Preprint
Che-Wei Chang and Karl Schmid. 2023. GGoutlieR: an R package to identify and visualize unusual geo-genetic patterns of biological samples. bioRxiv. DOI: https://doi.org/10.1101/2023.04.06.535838
Owner
- Name: kjschmidlab
- Login: kjschmidlab
- Kind: organization
- Repositories: 1
- Profile: https://github.com/kjschmidlab
JOSS Publication
GGoutlieR: an R package to identify and visualize unusual geo-genetic patterns of biological samples
Authors
Tags
landscape genomics K nearest neighbors geo-genetic patternsGitHub Events
Total
Last Year
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Che-Wei Chang | c****c@u****e | 124 |
| Che-Wei Chang | c****g@u****e | 51 |
| Karl Schmid | k****d@u****e | 4 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 4
- Total pull requests: 1
- Average time to close issues: 2 months
- Average time to close pull requests: 12 days
- Total issue authors: 2
- Total pull request authors: 1
- Average comments per issue: 3.0
- Average comments per pull request: 1.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- tkchafin (3)
Pull Request Authors
- tkchafin (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v3 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action master composite
- R >= 3.5.0 depends
- FastKNN * imports
- RColorBrewer * imports
- cowplot * imports
- doParallel * imports
- dplyr * imports
- foreach * imports
- ggforce * imports
- ggfun * imports
- ggplot2 * imports
- iterators * imports
- parallel * imports
- rlang * imports
- rnaturalearth * imports
- rnaturalearthdata * imports
- scales * imports
- sf * imports
- stats * imports
- stats4 * imports
- tidyr * imports
- utils * imports
