Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/weecology/portalr

A collection of functions to summarize the Portal Data
https://github.com/weecology/portalr

community-ecology ecology small-mammal-trapping

Last synced: 3 months ago
JSON representation

A collection of functions to summarize the Portal Data

Host: GitHub
URL: https://github.com/weecology/portalr
Owner: weecology
License: other
Created: 2017-02-03T03:16:22.000Z (almost 8 years ago)
Default Branch: main
Last Pushed: 2024-08-08T19:36:00.000Z (3 months ago)
Last Synced: 2024-08-09T19:57:40.658Z (3 months ago)
Topics: community-ecology, ecology, small-mammal-trapping
Language: R
Homepage: https://weecology.github.io/portalr/
Size: 14.8 MB
Stars: 11
Watchers: 8
Forks: 13
Open Issues: 8
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

jimsghstars - weecology/portalr - A collection of functions to summarize the Portal Data (R)

README

        ---

output: github_document

---

```{r, echo = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/"

)

library(portalr)

```

# portalr 

[![R-CMD-check](https://github.com/weecology/portalr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/weecology/portalr/actions/workflows/R-CMD-check.yaml)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/weecology/portalr/main/LICENSE)

[![Codecov test coverage](https://codecov.io/gh/weecology/portalr/graph/badge.svg)](https://app.codecov.io/gh/weecology/portalr)

[![CRAN downloads](https://cranlogs.r-pkg.org/badges/grand-total/portalr)](https://CRAN.R-project.org/package=portalr)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1429290.svg)](https://doi.org/10.5281/zenodo.1429290)

[![DOI](http://joss.theoj.org/papers/10.21105/joss.01098/status.svg)](https://doi.org/10.21105/joss.01098)

[![NSF-1929730](https://img.shields.io/badge/NSF-1929730-blue.svg)](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1929730)

## Overview 

The **portalr** package provides collection of basic functions to summarize the Portal project data on rodents, plants, ants, and weather at our long-term field site in the Chihuahuan Desert. The data begin in 1977 and are continuously updated today. There are functions to summarize rodent abundance, biomass, or energy and by site, plot, or treatment type. There are functions to summarize the weather data collected from our automated weather stations and plant data that is collected each summer and fall.

## Installation

You can install portalr from CRAN with:

```{r CRAN-installation, eval = FALSE}

install.packages("portalr")

```

OR from github with:

```{r gh-installation, eval = FALSE}

# install.packages("remotes")

remotes::install_github("weecology/portalr")

```

## Examples

1. Load all data tables from the [PortalData GitHub repo](https://github.com/weecology/portalData):

```{r load data from repo, eval = FALSE}

data_tables <- load_rodent_data("repo")

```

2. Download and generate summaries of rodent abundance and biomass:

```{r download and summarize rodent data, eval = FALSE}

download_observations(".")

rodent_data <- abundance(".") # default grouping is by sampling period

rodent_biomass_by_plot <- biomass(".", level = "plot", type = "granivores", 

shape = "flat", time = "date")

```

3. Retrieve weather data:

```{r weather data, eval = FALSE}

weatherdata <- weather("Monthly", ".")

```

For more detailed info, checkout the vignettes associated with the package:

```{r browse vignettes, eval = FALSE}

browseVignettes("portalr")

```

## More Information

#### [Portal Data Repo](https://github.com/weecology/PortalData) 

The data repo contains useful details for issues with data collection, and background on why we handle them the way we do. Of course, it also contains the raw data, if you would like to create more complex data summaries than what is provided here.

#### [The Portal Project](https://portal.weecology.org/)

Find a list of previous publications using the Portal data at our website.

#### [The Portal Blog](https://portalproject.wordpress.com/)

Follow our blog to get the latest news on what is happening with our project and at the site.

## Citation

To cite `portalr`, please refer to either:

* [JOSS publication](https://doi.org/10.21105/joss.01098):

  Erica M. Christensen, Glenda M. Yenni, Hao Ye, Juniper L. Simonis, Ellen K. Bledsoe, Renata M. Diaz, Shawn D. Taylor, Ethan P. White, and S. K. Morgan Ernest. (2019). portalr: an R package for summarizing and using the Portal Project Data. Journal of Open Source Software, 4(33), 1098, https://doi.org/10.21105/joss.01098

* or use the most recent release on [Zenodo](https://doi.org/10.5281/zenodo.1429290).

### Dataset Citation

To cite the Portal dataset, use:

```{r}

get_dataset_citation()

```