Skip to content

Commit

Permalink
build readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adokter committed Jul 15, 2023
1 parent c873818 commit c6df499
Showing 1 changed file with 26 additions and 30 deletions.
56 changes: 26 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,6 @@ status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repost
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3370004.svg)](https://doi.org/10.5281/zenodo.3370004)
<!-- badges: end -->

**bioRad is temporarily unavailable on CRAN - please install from GitHub**

*bioRad will be released as soon as CRAN has resolved infrastructure issues
(see 'Submitting to CRAN' at https://cran.r-project.org/)*

bioRad provides standardized methods for extracting and reporting
biological signals from weather radars. It includes functionality to
inspect low-level radar data, process these data into meaningful
Expand All @@ -28,24 +23,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 @@ -102,8 +97,8 @@ Then load the package with:

``` r
library(bioRad)
#> Welcome to bioRad version 0.7.1
#> using vol2birdR version 1.0.1 (MistNet not installed)
#> Welcome to bioRad version 0.7.0.9617
#> using vol2birdR version 1.0.1 (MistNet installed)
```

### (optional) Enable MistNet
Expand Down Expand Up @@ -201,11 +196,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 c6df499

Please sign in to comment.