Skip to content

Commit

Permalink
added version number to README
Browse files Browse the repository at this point in the history
  • Loading branch information
nevrome committed Feb 24, 2023
1 parent a9736fc commit b2066cd
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ version](https://img.shields.io/github/r-package/v/nevrome/mobest)

# mobest

This R package provides types and functions for spatiotemporal interpolation of human genetic ancestry components, similarity search and the calculation of a derived measure for **mob**ility **est**imation. The workflow in version X.X.X was specifically developed to support this research compendium: <https://github.com/nevrome/mobest.analysis.2022>.
This R package provides types and functions for spatiotemporal interpolation of human genetic ancestry components, similarity search and the calculation of a derived measure for **mob**ility **est**imation. The workflow in version 1.0.0 was specifically developed to support this research compendium: <https://github.com/nevrome/mobest.analysis.2022>.

<img align="right" src="man/figures/example_movie.gif" width = 380>

0. `mobest` assumes you have a set of genetic samples with spatial (two coordinates in a projected reference system) and temporal positions (years BC/AD) for which you calculated a derived, numeric measure of genetic ancestry (e.g. coordinates in a PCA or MDS space).
1. `mobest` provides a framework to perform spatiotemporal interpolation using Gaussian process regression (kriging) with the [`laGP`](https://CRAN.R-project.org/package=laGP) package to reconstruct an ancestry field based on the ancestry measure you provided.
2. `mobest` allows to derive a similarity probability for samples of interest within the interpolated field, which -- under certain circumstances -- can be interpreted as an origin probability. See the [example gif](man/figures/) on the right.
2. `mobest` allows to derive a similarity probability for samples of interest within the interpolated field, which -- under certain circumstances -- can be interpreted as an origin probability. See the [example GIF](man/figures/) on the right.
3. `mobest` finally introduces functions to estimate and summarize a measure of mobility for the samples of interest, based on the similarity probability field.

Here is a simple, artificial example how 2. can be used:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ version](https://img.shields.io/github/r-package/v/nevrome/mobest)
This R package provides types and functions for spatiotemporal
interpolation of human genetic ancestry components, similarity search
and the calculation of a derived measure for **mob**ility
**est**imation. The workflow in version X.X.X was specifically developed
**est**imation. The workflow in version 1.0.0 was specifically developed
to support this research compendium:
<https://github.com/nevrome/mobest.analysis.2022>.

Expand All @@ -28,7 +28,7 @@ to support this research compendium:
2. `mobest` allows to derive a similarity probability for samples of
interest within the interpolated field, which – under certain
circumstances – can be interpreted as an origin probability. See the
[example gif](man/figures/) on the right.
[example GIF](man/figures/) on the right.
3. `mobest` finally introduces functions to estimate and summarize a
measure of mobility for the samples of interest, based on the
similarity probability field.
Expand Down

0 comments on commit b2066cd

Please sign in to comment.