README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

<!-- badges: start -->
  [![R-CMD-check](https://github.com/ntmv/handyhelper/workflows/R-CMD-check/badge.svg)](https://github.com/ntmv/handyhelper/actions)
<!-- badges: end -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```


# angler

Sexual dimorphism  (i.e the differences between males and females) is largely prevalent in the natural world, and has been widely observed to be exhibited in a range of patterns across various clades. A critical issue that hampers the study of sexual dimorphism is the lack of standardized measures in the literature to calculate sexual shape and size dimorphism. `angler` computes a set of commonly used measures of sexual size dimorphism (SSD) and shape dimorphism (SShD) from landmark based morphometric data for future studies to conveniently calculate standardized effect sizes of sexual dimorphism. The package additionally computes a bootstrapped-based standard error for the various measures included in the package.

## Installation

This package is not available on CRAN as of this date (although it is intended to be submitted soon). You can install the development version of angler from GitHub by running the following line of code:

``` r
devtools::install_github("ntmv/angler")
```

## To Do List

- [ ] Clean up documentation of functions 
- [ ] More error checks for sample sizes for within-strata bootstrapping
- [ ] General function check
- [ ] Testing
- [ ] Update README with examples
- [ ] Add vignette and pkgdown website for code documentation and examples
- [ ] General formatting 

## Additional potential features of interest

- [ ] Mahalanobis distance: sparse variance-covariance estimation