From c6df49972c41e17caa617fc27ca51ad9fe01ab06 Mon Sep 17 00:00:00 2001 From: Adriaan Dokter Date: Fri, 14 Jul 2023 21:04:54 -0400 Subject: [PATCH] build readme --- README.md | 56 ++++++++++++++++++++++++++----------------------------- 1 file changed, 26 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 69daa7cc..13b46721 100644 --- a/README.md +++ b/README.md @@ -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) -**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 @@ -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/). @@ -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 @@ -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.