Giter Club home page Giter Club logo

circmle's Introduction

CircMLE

Maximum Likelihood Analysis of Circular Data

Description

A series of wrapper functions to implement the 10 maximum likelihood models of animal orientation described by Schnute and Groot (1992) doi: 10.1016/S0003-3472(05)80068-5. The functions also include the ability to use different optimizer methods and calculate various model selection metrics (i.e., AIC, AICc, BIC). This framework is designed for modeling any dataset represented by angles (e.g, orientation, periodic, etc) using the above models. Main features are listed as follows.

  • Calculate the likelihood of any one or all of the 10 models of orientation
  • Compare any two nested models using a likelihood ratio test
  • Plot the observed dataset and any of the model-fitted results
  • Calculate the Hermans-Rasson test or Pycke test for directionality

Install CircMLE (from an R console)

  • To install from CRAN
    • First install the R package 'circular' from CRAN using the command install.packages("circular")
    • Then install the CircMLE package using install.packages("CircMLE")
    • Load the package into your working R environment using library(CircMLE)

Version History

  • Version 3.0.0 2020/2/9

    • Added the circular distance correlation function. Thanks Matt Robinson for the great ideas and discussion!
    • the model fitting function now includes the hessian matrix, and a function ci_circmle to calculate 95% confidence intervals for the MLE parameters.
      • Thanks Oliver Mitesser (University of Wörzburg) for the recommendation!
  • Version 0.2.3 2020/1/29

    • Added the ability to perform the Hermans-Rasson and Pycke tests using code kindly provided by Lukas Landler, Graeme Ruxton, and E. Pascal Malkemper.
  • Version 0.2.2 2019/10/17

    • Improved communication between CircMLE and R 'circular' objects, especially for improved plotting when using 'template = "geographics"'.
  • Version 0.2.1 2018/02/20

    • Added support for data vectors with the "geographics" template set when plotting the modeled results.
    • Added publication information
    • Added the README.md file
  • Version 0.2.0 2017/06/29

    • Added a plotting function to visualize the observed and modeled results
  • Version 0.1, 2017/05/13

    • Released the first version

Citation

Fitak, R. R. and Johnsen, S. (2017) Bringing the analysis of animal orientation data full circle: model-based approaches with maximum likelihood. Journal of Experimental Biology 220: 3878-3882; doi: 10.1242/jeb.167056

If using the Hermans-Rasson or Pycke tests then cite:
Landler, L., Ruxton, G. D., and Malkemper, E. P. (2019) The Hermans–Rasson test as a powerful alternative to the Rayleigh test for circular statistics in biology. BMC Ecology 19: 30; doi: 10.1186/s12898-019-0246-8

  • Or enter the command citation("CircMLE") into your R console

Contact

Robert Fitak
Department of Biology
University of Central Florida
USA
[email protected]

circmle's People

Contributors

rfitak avatar

Watchers

 avatar  avatar  avatar

circmle's Issues

"lamda" -> "lambda"

@rfitak Very useful tool, thanks for publishing.
Could "lamda" in the results table from circ_mle be changed to "lambda" for ease of typing?
Alternately, it might be nice for parameters to have the same names as the input parameters to mixedvonmises (i.e. mu1, mu2, kappa1, kappa2, prop).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.