respR

respR - Analyse, convert, and automate respirometry-related and time-series data

https://github.com/januarharianto/respr

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 6 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    2 of 6 committers (33.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.7%) to scientific vocabulary

Keywords

r respirometry rstudio
Last synced: 6 months ago · JSON representation ·

Repository

respR - Analyse, convert, and automate respirometry-related and time-series data

Basic Info
Statistics
  • Stars: 12
  • Watchers: 5
  • Forks: 2
  • Open Issues: 6
  • Releases: 20
Topics
r respirometry rstudio
Created over 9 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Funding Citation

README.md

respR : Processing and analysis of respirometry data

CRAN_Status_Badge metacran downloads R-CMD-check Codecov test coverage License DOI Github Star Github watchers Github sponsor Mastodon

respR is a package for R that provides a structural, reproducible workflow for the processing and analysis of respirometry data. While the focus of the package is on aquatic respirometry, respR is largely unitless and so can process, explore, and determine rates from any respirometry data, and indeed linear relationships in any time-series data.

Use respR to:

  • Inspect respirometry data for common issues before analysis
  • Explore and visualise oxygen timeseries
  • Calculate rates manually or automatically using multiple regression analysis
  • Adjust rates for background oxygen consumption or production
  • Convert rates to any common unit of oxygen consumption or production
  • Select rates according to various criteria
  • Export results quickly for reporting
  • Identify critical oxygen values, such as $P_{crit}$

A highlight of the package is the auto_rate() function. This uses machine learning (kernel density estimation) to automatically identify linear regions of data, that is regions where oxygen uptake or production rates are stable and consistent. This allows metabolic rates to be extracted in an objective manner. See vignette("auto_rate") for more details.

Installation

respR is now available on CRAN, and can be installed via the 'Packages' tab in RStudio or by running this command:

r install.packages("respR")

You can also install the latest version direct from Github:

r devtools::install_github("januarharianto/respR")

Getting started

Visit the respR website to get started. The site has a range of vignettes detailing the functionality, plus example workflows, documentation, and more.

We are also happy to help directly. If you have problems using the package or getting started with your analysis, get in touch with a sample of your data and we will help get you started.

Publication

The package has also been peer reviewed and published in Methods in Ecology and Evolution. Please cite this publication if you use respR in your published work.

respR has been used to examine metabolic rates and photosynthesis in corals, plankton, micro- and macro-algae, fish, crustaceans, echinoderms, cephalopods, bivalves and more, in both lab and field studies. Check the respR Citations page to see a list of published studies which have used the package to analyse their data.

 \  \  

Contact, feedback and help

See here for more ways of providing feedback and getting in touch if you are having issues.

For the latest news and regular updates from the world of respirometry follow respR on Mastodon.

Support package development

If you would like to help support the package development or just buy us a beer to say thanks see here

Developers

Usage

For a quick evaluation of the package, try out the following code:

```r library(respR) # load the package

1. Check data for errors, selecting cols 1 and 15:

urch <- inspect(urchins.rd, time = 1, oxygen = 15)

2. Automatically determine most linear regions:

rate <- auto_rate(urch)

3. Convert

out <- convert_rate(rate, oxy.unit = "mg/L", time.unit = "min", output.unit = "mg/h/kg", volume = 0.6, mass = 0.4) print(out)

Alternatively, use pipes:

urchins.rd %>% # using the urchins dataset, select(1, 15) %>% # select columns 1 and 15 inspect() %>% # inspect the data, then autorate() %>% # automatically determine most linear segment print() %>% # a quick preview convertrate("mg/L", "min", "mg/h/kg", 0.6, 0.4) # convert to units ```

Owner

  • Name: Januar Harianto
  • Login: januarharianto
  • Kind: user
  • Location: NSW, Australia
  • Company: The University of Sydney

Lecturer @ University of Sydney and Data Scientist @ Sydney Informatics Hub

Citation (CITATION.cff)

cff-version: 1.2.0
message: "Please cite respR in publications using the following journal article:"
authors:
- family-names: "Harianto"
  given-names: "Januar"
  orcid: ""
- family-names: "Carey"
  given-names: "Nicholas"
  orcid: ""
title: "respR — An R package for the manipulation and analysis of respirometry data"
version: 2.3.0
doi: 10.1111/2041-210X.13162
date-released: 2022-06-05
url: "https://github.com/januarharianto/respR"
preferred-citation:
  type: article
  authors:
  - family-names: "Harianto"
    given-names: "Januar"
    orcid: ""
  - family-names: "Carey"
    given-names: "Nicholas"
    orcid: ""
  - family-names: "Byrne"
    given-names: "Maria"
    orcid: ""
  doi: "10.1111/2041-210X.13162"
  journal: "Methods in Ecology and Evolution"
  month: 2
  start: 912 # First page number
  end: 920 # Last page number
  title: "respR — An R package for the manipulation and analysis of respirometry data"
  issue: 6
  volume: 10
  year: 2019

GitHub Events

Total
  • Issue comment event: 5
  • Push event: 43
Last Year
  • Issue comment event: 5
  • Push event: 43

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 1,541
  • Total Committers: 6
  • Avg Commits per committer: 256.833
  • Development Distribution Score (DDS): 0.451
Past Year
  • Commits: 85
  • Committers: 1
  • Avg Commits per committer: 85.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Januar Harianto j****o@s****u 846
nicholascarey n****y@g****m 662
Januar Harianto j****o@J****n 20
Januar Harianto j****o@J****l 8
Januar Harianto s****d@v****u 4
Hadley Wickham h****m@g****m 1

Packages

  • Total packages: 1
  • Total downloads:
    • cran 333 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 9
  • Total maintainers: 1
cran.r-project.org: respR

Import, Process, Analyse, and Calculate Rates from Respirometry Data

  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 333 Last month
Rankings
Forks count: 17.8%
Stargazers count: 17.9%
Average: 26.2%
Dependent packages count: 29.8%
Downloads: 30.3%
Dependent repos count: 35.5%
Maintainers (1)
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.3 depends
  • data.table * imports
  • dplyr * imports
  • glue * imports
  • grDevices * imports
  • graphics * imports
  • lubridate * imports
  • magrittr * imports
  • marelac * imports
  • purrr * imports
  • readxl * imports
  • roll * imports
  • segmented * imports
  • stats * imports
  • stringr * imports
  • utils * imports
  • xml2 * imports
  • DiagrammeR * suggests
  • FishResp * suggests
  • covr * suggests
  • knitr * suggests
  • rMR * suggests
  • respirometry * suggests
  • rmarkdown * suggests
  • testthat * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-r-dependencies v1 composite
.github/workflows/r.yml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-r f57f1301a053485946083d7a45022b278929a78a composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite