Skip to content

Commit

Permalink
Merge branch 'filter_vpts_documentation'
Browse files Browse the repository at this point in the history
  • Loading branch information
adokter committed Oct 24, 2024
2 parents f9bd423 + feda696 commit 0c13484
Showing 1 changed file with 31 additions and 27 deletions.
58 changes: 31 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ status](https://www.r-pkg.org/badges/version/bioRad)](https://cran.r-project.org
status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![codecov](https://codecov.io/gh/adokter/bioRad/branch/master/graph/badge.svg?token=pDmyO4JVJu)](https://app.codecov.io/gh/adokter/bioRad)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3370004.svg)](https://doi.org/10.5281/zenodo.3370004)
[![vol2birdR
DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13362111.svg)](https://doi.org/10.5281/zenodo.13362111)
[![vol2birdR CRAN
status](https://www.r-pkg.org/badges/version/vol2birdR)](https://cran.r-project.org/package=vol2birdR)

<!-- badges: end -->

bioRad provides standardized methods for extracting and reporting
Expand All @@ -23,24 +28,24 @@ calculate further summary statistics.

To get started, see:

- [Dokter et al. (2019)](https://doi.org/10.1111/ecog.04028): a paper
describing the package.
- [bioRad
vignette](https://adriaandokter.com/bioRad/articles/bioRad.html): an
introduction to bioRad’s main functionalities.
- [Function
reference](https://adriaandokter.com/bioRad/reference/index.html): an
overview of all bioRad functions.
- [Introductory
exercises](https://adriaandokter.com/bioRad/articles/rad_aero_19.html):
a tutorial with code examples and exercises.
- [Dokter et al. (2019)](https://doi.org/10.1111/ecog.04028): a paper
describing the package.
- [bioRad
vignette](https://adriaandokter.com/bioRad/articles/bioRad.html): an
introduction to bioRad’s main functionalities.
- [Function
reference](https://adriaandokter.com/bioRad/reference/index.html):
an overview of all bioRad functions.
- [Introductory
exercises](https://adriaandokter.com/bioRad/articles/rad_aero_19.html):
a tutorial with code examples and exercises.

More vignettes:

- [Range
correction](https://adriaandokter.com/bioRad/articles/range_correction.html):
estimate spatial images of vertically integrated density corrected for
range effects.
- [Range
correction](https://adriaandokter.com/bioRad/articles/range_correction.html):
estimate spatial images of vertically integrated density corrected
for range effects.

Documentation for the latest development version can be found
[here](https://adriaandokter.com/bioRad/dev/).
Expand Down Expand Up @@ -97,10 +102,8 @@ Then load the package with:

``` r
library(bioRad)
#> Welcome to bioRad version 0.8.1
#> Attempting to load MistNet from:/Users/amd427/Library/R/x86_64/4.3/library/vol2birdR/lib
#> MistNet successfully initialized.
#> using vol2birdR version 1.0.3 (MistNet installed)
#> Welcome to bioRad version 0.8.1.9000
#> using vol2birdR version 1.0.4 (MistNet installed)
```

### (optional) Enable MistNet
Expand Down Expand Up @@ -198,11 +201,12 @@ tutorial](https://adriaandokter.com/bioRad/articles/rad_aero_19.html).

## Meta

- We welcome
[contributions](https://adriaandokter.com/bioRad/CONTRIBUTING.html)
including bug reports.
- License: MIT
- Get citation information for `bioRad` in R doing `citation("bioRad")`.
- Please note that this project is released with a [Contributor Code of
Conduct](https://adriaandokter.com/bioRad/CODE_OF_CONDUCT.html). By
participating in this project you agree to abide by its terms.
- We welcome
[contributions](https://adriaandokter.com/bioRad/CONTRIBUTING.html)
including bug reports.
- License: MIT
- Get citation information for `bioRad` in R doing
`citation("bioRad")`.
- Please note that this project is released with a [Contributor Code
of Conduct](https://adriaandokter.com/bioRad/CODE_OF_CONDUCT.html).
By participating in this project you agree to abide by its terms.

0 comments on commit 0c13484

Please sign in to comment.