silvicultureRInventory/README.Rmd at main · GJprocode/silvicultureRInventory · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
---
output: github_document
---
# silviculture <a href="https://github.com/Cidree/silviculture"><img src="man/figures/logo.png" alt="silviculture website" align="right" height="138"/></a>

<!-- badges: start -->

[![CRAN status](https://www.r-pkg.org/badges/version/silviculture)](https://CRAN.R-project.org/package=silviculture) [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) [![Codecov test coverage](https://codecov.io/gh/Cidree/silviculture/graph/badge.svg)](https://app.codecov.io/gh/Cidree/silviculture) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

<!-- badges: end -->

`silviculture` is an R package designed to streamline the analysis of forestry and forest inventory data, offering a range of functions for common silvicultural analysis. It aims to support forest management and research by providing a flexible toolkit for data manipulation and summary.

## Installation

You can install the development version of `silviculture` from [GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pak("Cidree/silviculture")
```

## Roadmap

This package is currently under active development and may still contain bugs or unstable features. I do not recommend using it in real-world applications at this stage, as it may be prone to errors.

## Nomenclature

The package uses the following terms as function arguments consistently:

* `biomass`: mass of the tree or part of the tree in kilograms.

* `dclass`: the diametric class of the tree. In forestry we typically work with diametric classes instead of raw diameters. Therefore, we often create diametric classes with a range of 5 or 10 centimeters.

* `diameter`: diameter of the tree, typically refering to the diameter at breast height (1.30 meters) expressed in centimeters.

* `h0 (dominant height)`: the mean height of the 100 thickest trees per hectare (Assman); or the mean height of the 100 tallest trees per hectare (Hart).

* `g (basal area)`: the basal area of the tree, which is typically expressed by the symbol `G`. It is expressed as squared meters per hectare ( m^2^/ha).

* `height`: it refers to the total height of the tree in meters.

* `Lorey's height`: tree's mean height weighted by basal area.

* `ntrees`: number of trees (typically of the same diameter).

* `species`: Latin name of the tree species (e.g. *Pinus pinaster*).

* `volume`: estimated volume of the tree in cubic meters (m^3^).

## Contributing

Contributions to `silviculture` are highly appreciated! If you have ideas for improvements or new features, feel free to:

-   Open an [issue](https://github.com/Cidree/silviculture/issues) for bugs or feature requests.

-   Submit a [pull request](https://github.com/Cidree/silviculture/pulls) for code contributions.

-   Share feedback on usage, examples, or additional functionality.

## License

This project is licensed under the GPL-3 License.