diff --git a/README.md b/README.md index aa8b1c2f0bf0a19d365a9bdadd23988e020a4163..e93d765c2aa2564e2fca3f78875713e5d2f9008a 100755 --- a/README.md +++ b/README.md @@ -1,32 +1,4 @@ -# Overview +# IMPORTANT NOTICE -`lidaRtRee` is an `R` package that provides functions for **forest analysis using airborne laser scanning** (LiDAR remote sensing) data: tree detection / segmentation and area-based approach. It includes complementary steps for forest mapping: extraction of both physical (gaps, edges, trees) and statistical features from LiDAR data, model calibration with ground reference, and maps export. - -# Installation - -* `R` >= 4.2.3 recommended, package `lidR` >= 4.0.0 required -* **The package is available on [CRAN](https://cran.r-project.org/package=lidaRtRee)**, to install run in the `R` console `install.packages("lidaRtRee")` -* **build development version from source** with the `devtools` package by running in an `R` console: `devtools::install_git("https://gitlab.irstea.fr/jean-matthieu.monnet/lidaRtRee/")` - -# Tutorials - -**Tutorials** using `lidaRtRee` functions are available on the [lidaRtRee_tutorials](https://gitlab.irstea.fr/jean-matthieu.monnet/lidartree_tutorials/) repository, as `Rmarkdown` files and `html` files, and including datasets to run the code. The [wiki](https://gitlab.irstea.fr/jean-matthieu.monnet/lidartree_tutorials/-/wikis/home) presents the different tutorials: - -* [ALS data pre-processing](https://gitlab.irstea.fr/jean-matthieu.monnet/lidartree_tutorials/-/wikis/ALS-data-preprocessing) -* [Tree detection](https://gitlab.irstea.fr/jean-matthieu.monnet/lidartree_tutorials/-/wikis/Tree-segmentation) -* [Forest field plot coregistration with ALS data](https://gitlab.irstea.fr/jean-matthieu.monnet/lidartree_tutorials/-/wikis/Field-plot-coregistration-with-ALS-data) -* [Forest gaps and edges detection](https://gitlab.irstea.fr/jean-matthieu.monnet/lidartree_tutorials/-/wikis/Forest-gaps-and-edges-detection) -* [Forest structure metrics computation and mapping](https://gitlab.irstea.fr/jean-matthieu.monnet/lidartree_tutorials/-/wikis/Forest-structure-metrics-mapping) -* [Area-based approach for forest parameters estimation](https://gitlab.irstea.fr/jean-matthieu.monnet/lidartree_tutorials/-/wikis/Area-based-approach) - -# Changelog - -4.0.5 (April 2023) max.width parameter in function maxima_detection is expect to be in raster units if a SpatRaster is provided; default value is now 11. Function tree_segmentation now expects arguments passed to sub function as ... rather than names arguments; default values for those sub-functions were modified to match with the default values which were used in tree_segmentation ; a warning is issued in case max.width argument (passed to maxima_detection) is not consistent with the dmin or dprop arguments (passed to maxima_selection). - -4.0.3 (July 2022) fixes the number of decimals for WKT coordinates of crown in function `tree_extraction`. - -4.0.2 (July 2022) adds a global function `tree_detection` which includes both the segmentation and extraction, and can be applied to SpatRaster, LAS or LAS-catalog objects. The function `gap_detection` now also accepts LAS and LAS-catalog objects as input. - -4.0.1 (May 2022) now relies on [terra](https://cran.r-project.org/package=terra) and [sf](https://cran.r-project.org/package=sf) packages instead of [raster](https://cran.r-project.org/package=raster) and [sp](https://cran.r-project.org/package=sp). - -3.1.0 (July 2021) introduces names modifications for better constituency. Tests have been added. \ No newline at end of file +* R package `lidaRtRee` has moved to [https://forgemia.inra.fr/lidar/lidaRtRee](https://forgemia.inra.fr/lidar/lidaRtRee) +* Documentation and tutorials are on [https://lidar.pages.mia.inra.fr/lidaRtRee/](https://lidar.pages.mia.inra.fr/lidaRtRee/) \ No newline at end of file