README.md

openpopscr

Fits open population spatial capture-recapture with activity centre movement by maximum likelihood.

Install

In R, the latest release can be install using the devtools package with the command:

devtools::install_github("r-glennie/openpopscr", build = TRUE, build_opts = c("--no-resave-data", "--no-manual"), build_vignettes = TRUE)

The package requires you have a C compiler installed on your system. Windows users may need to install R-tools for this reason. It is assumed Linux and Mac users have a compiler installed.

Use

The package consists of different classes. Each class describes a particular kind of object. Objects have properties and functions that you can use. In this package, there are two main types of classes: models and data. The ScrData class is used to create data objects; other classes such as ScrModel, CjsModel, ScrTransientModel, are used to create model objects that you can fit to your data and obtain inference from.

There is a vignette for each class. To see a list of all vignettes, use the command:

browseVignettes("openpopscr")

To learn how to use the package, I recommend reading the ScrData and ScrModel vignettes first. The rest are very similar to these vignettes, making it easier to use other classes once the basics are familiar.

Also, the folder inst/examples/ in the repository contains code showing how to fit each type of model to simulated data.

Issues

This package is under development. I'd be grateful for anyone who has issues with the package to open an issue or contact me.



r-glennie/openpopscr documentation built on Oct. 9, 2021, 9:01 p.m.