perutimber

Catalogue Of The Timber Forest Species Of The Amazon And The Peruvian Yunga

https://github.com/paulesantos/perutimber

Repository

Catalogue Of The Timber Forest Species Of The Amazon And The Peruvian Yunga

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```


# perutimber 
## 


[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![CRAN status](https://www.r-pkg.org/badges/version/perutimber)](https://CRAN.R-project.org/package=perutimber)
[![R-CMD-check](https://github.com/PaulESantos/perutimber/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/PaulESantos/perutimber/actions/workflows/R-CMD-check.yaml)
[![](http://cranlogs.r-pkg.org/badges/grand-total/perutimber?color=green)](https://cran.r-project.org/package=perutimber)
[![](http://cranlogs.r-pkg.org/badges/last-week/perutimber?color=green)](https://cran.r-project.org/package=perutimber)




The R package, `perutimber`, provides easy access to taxonomic information for over 1,300 vascular plant species found in the **"Catalogue of the timber forest species of the Amazon and the Peruvian Yunga"**. This package is based on the authoritative publication by [Vásquez Martínez and Rojas Gonzáles (2022) titled "Catálogo de las especies forestales maderables de la Amazonía y la Yunga Peruana" in Revista Forestal del Perú 37(3, Número Especial): 5-138](https://revistas.lamolina.edu.pe/index.php/rfp/article/view/1956). With `perutimber`, researchers and enthusiasts alike can efficiently explore and analyze the timber plant species.

## Installation

You can install the `perutimber` package from CRAN using:

```r
install.packages("perutimber")

# or

pak::pak("perutimber")
```

Also you can install the `perutimber` package from GitHub using the following command:

``` r
pak::pak("PaulESantos/perutimber")
```

## Basic usage

- Check if species name it listed in the data base:

```{r sps_search}
library(perutimber)
sps_list <- c("Pentaplaris davidsmithii", 
              "Quararibea wittiia",
              "Sterculia tessmanni", 
              "Sterculia tessmannia", 
              "Brosimum alicastrum subsp. bolivarense",
              "Brosimum alicastrum sub bolivarense",
              "Poa annua")

```

 -  `perutimber::search_perutimber` function can be used over a vector of species names. You can pass a character vector containing multiple species names as an argument to the function, and it will check whether each of those species names is listed in the data. The function will return a character vector indicating whether each species name is present or not. Here's an example:

 
```{r vect_search}
perutimber::search_perutimber(splist = sps_list)
```

 - `perutimber::search_perutimber` can be used with a data.frame or tibble. Here's an example of how to use it:
 
```{r tbl_search}
 # base R

sps_df <- data.frame(sps_list)
sps_df
sps_df$review <- perutimber::search_perutimber(splist = sps_list)
sps_df

 # tidyverse - tibble

sps_tbl <- tibble::tibble(sps_list)
sps_tbl |> 
  dplyr::mutate(review = perutimber::search_perutimber(splist = sps_list))

```

- `perutimber::get_perutimber_data()` allows access to information provided in the "Catalogue of the timber forest species of the Amazon and the Peruvian Yunga", to obtain information for a specific species, a species name vector must be provided as input. The function returns a data frame containing basic information for each species, such as its common and scientific names.

```{r get_data}
perutimber::get_perutimber_data(sps_list)

```

Owner

GitHub Events

Packages