Skip to content

Commit

Permalink
fix some typos and links
Browse files Browse the repository at this point in the history
  • Loading branch information
connor-french committed Jul 3, 2024
1 parent 7d9ca49 commit ed35685
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions docs/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,19 @@ format:

## *Overview*

*spaceprime* is a Python package that facilitates the use of **spatially explicit coalescent modeling** in the *msprime* library. The package is designed to make it easier for practitioners to **convert spatial maps of habitat suitability into extensible two-dimensional stepping-stone models of gene flow**, where each pixel of the map represents a deme and demes are able to migrate with their neighbors. Demes and migration rates are able to change over time according to habitat suitability model projections to different time periods. These demographic parameters are then used to simulate genetic data under a coalescent model with *msprime* as the simulator, which can be used to infer the demographic history of the population. The package is designed to be **user-friendly and intuitive**, allowing users to easily simulate and analyze spatially explicit genetic data.
*spaceprime* is a Python package that facilitates the use of **spatially explicit coalescent modeling** in the [msprime](https://tskit.dev/msprime/docs/stable/intro.html#) library. The package is designed to make it easier for practitioners to **convert spatial maps of habitat suitability into extensible two-dimensional stepping-stone models of gene flow**, where each pixel of the map represents a deme and demes are able to migrate with their neighbors. Demes and migration rates are able to change over time according to habitat suitability model projections to different time periods. These demographic parameters are then used to simulate genetic data under a coalescent model with [msprime](https://tskit.dev/msprime/docs/stable/intro.html#) as the simulator, which can be used to infer the demographic history of the population. The package is designed to be **user-friendly and intuitive**, allowing users to easily simulate and analyze spatially explicit genetic data.

This page provides an overview of the package and its main features. For more detailed information, please refer to the [documentation](https://connor-french.github.io/spaceprime).

**Note for R users**: *spaceprime* is coded in Python, yet many interested users may come from an R background. I have a [*spaceprime* for R users]() vignette (COMING SOON) that provides a brief introduction to the Python concepts necessary to use *spaceprime* in a practical walk-through of an example analysis. Additionally, it is possible to use Python code in R using the *reticulate* package. For more information on how to use Python code in R, see the [reticulate documentation](https://rstudio.github.io/reticulate/).
::: {.callout-note}
## Note for R users
*spaceprime* is implemented in Python, yet many interested users may come from an R background. I have a [*spaceprime* for R users]() vignette (COMING SOON) that provides a brief introduction to the Python concepts necessary to use *spaceprime* through a practical walk-through of an example analysis. If you still want to use R, it is possible to use Python code in R using the *reticulate* package. For more information on how to use Python code in R, see the [reticulate documentation](https://rstudio.github.io/reticulate/).
:::

## Main features

*spaceprime* includes a number of features: - **Convert habitat suitability values into demographic parameters**, including deme sizes, migration rates, and their change through time using **very little code**. Code complexity does not increase with model complexity, allowing users to focus on the biological questions they are interested in. - Simulate spatially explicit genetic data under a coalescent model with *msprime*. The modeling approach is **fully coalescent** with no forward-time component, allowing for **computationally efficient simulations** of large spatially explicit models.
*spaceprime* includes a number of features:

- **Convert habitat suitability values into demographic parameters**, including deme sizes, migration rates, and their change through time using **very little code**. Code complexity does not increase with model complexity, allowing users to focus on the biological questions they are interested in.
- Simulate spatially explicit genetic data under a coalescent model with *msprime*. The modeling approach is **fully coalescent** with no forward-time component, allowing for **computationally efficient simulations** of large spatially explicit models.
- Visualize demographic models to facilitate model interpretation and model checking.
- Compute genetic summary statistics for simulated and empirical data to facilitate comparison with empirical data.
- Extensibility: *spaceprime* is designed to be interoperable with *msprime*, where users can setup a model with *spaceprime*, then customize it using the full range of *msprime* functionality.
Expand All @@ -36,7 +39,7 @@ This page provides an overview of the package and its main features. For more de

### Stable release

*spaceprime* can be installed using `pip` or `conda`. Due to the package's reliance on `msprime`, the `pip` installation is only available on unix-based systems (MacOS, Linux). Windows users should install *spaceprime* using `conda`.
*spaceprime* can be installed using `pip` or `conda`. Due to the package's reliance on *msprime*, the `pip` installation is only available on unix-based systems (MacOS, Linux). Windows users should install *spaceprime* using `conda`.

To install *spaceprime* using `pip`, run the following command in your terminal:

Expand Down Expand Up @@ -101,6 +104,7 @@ Make sure to install the relevant analysis dependencies with `pip install spacep
::: {.callout-tip}
This quickstart guide assumes you have a basic understanding of Python. If you are an R user, please refer to the [spaceprime for R Users vignette](https://connor-french.github.io/spaceprime) for an overview of *spaceprime* with the necessary Python concepts explained.
:::

### 1. Download data

The data we're using in this example are a [GeoTiff](https://en.wikipedia.org/wiki/GeoTIFF) raster file of habitat suitability values and a [GeoJSON](https://geojson.org/) file containing geographic localities and metadata for this cute frog, *Phyllomedusa distincta*:
Expand Down

0 comments on commit ed35685

Please sign in to comment.