The fqar package

The fqar package: R tools for analyzing floristic quality assessment data - Published in JOSS (2024)

https://github.com/equitable-equations/fqar

Science Score: 95.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation

Repository

The fqar package provides R tools for downloading and analyzing floristic quality assessment data from www.universalFQA.org

Basic Info
  • Host: GitHub
  • Owner: equitable-equations
  • License: other
  • Language: R
  • Default Branch: main
  • Homepage:
  • Size: 1.56 MB
Statistics
  • Stars: 5
  • Watchers: 1
  • Forks: 4
  • Open Issues: 0
  • Releases: 1
Created over 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License

README.md

fqar

<!-- badges: start --> R-CMD-check CRAN status DOI

<!-- badges: end -->

Floristic Quality Assessment (FQA) is a standardized method for rating the ecological value of natural areas based on the plant species found within them. The ${\tt fqar}$ package provides tools to download and analyze floristic quality assessments from universalfqa.org, an online database maintained by Openlands.

Installation

The ${\tt fqar}$ package is available on CRAN.

{r install} install.packages("fqar")

Alternatively, the development version can be installed from GitHub.

{r github} devtools::install_github("equitable-equations/fqar")

Usage

The ${\tt fqar}$ package consists of four categories of functions: indexing, downloading, tidying, and analytic functions. ${\tt fqar}$ also includes two sample data sets.

Indexing functions

At the simplest level, fqar allows users to obtain specific information about the databases, assessments, and transect assessments available from universalfqa.org.

```{r indexing}

download a list of all fqa databases:

databases <- indexfqadatabases()

download a list of all assessments in a specific database:

chicagofqas <- indexfqaassessments(databaseid = 149)

download a list of all transect assessments in a specific database:

chicagotransects <- indexfqatransects(databaseid = 149) ```

Downloading functions

Floristic quality assessments can be downloaded individually by ID number or collectively using dplyr::filter syntax.

```{r downloading}

download a single assessment using the assessment_id assigned by

universalfqa.org. These identifiers

can be found using index_fqa_assessments.

woodland <- downloadassessment(assessmentid = 25640)

download multiple assessments:

mcdonaldfqas <- downloadassessmentlist(databaseid = 149, site == "McDonald Woods") ```

${\tt fqar}$ also provides functions for downloading transect assessments.

```{r downloading2}

download a single transect assessment:

rockgarden <- downloadtransect(transect_id = 6875)

download multiple transect assessments:

lordfqas <- downloadtransect_list(database = 63, practitioner == "Sam Lord") ```

Unfortunately, the universalfqa.org server is often slow, and downloads (especially for transect assessments) may take some time.

Tidying functions

Data sets obtained from universalfqa.org are quite messy. ${\tt fqar}$ provides tools for converting such sets into a more convenient tidy format.

```{r tidying}

obtain a data frame with species data for a downloaded assessment:

woodlandspecies <- assessmentinventory(woodland)

obtain a data frame with summary information for a downloaded assessment:

woodlandsummary <- assessmentglance(woodland)

obtain a data frame with summary information for multiple downloaded assessments:

mcdonaldsummary <- assessmentlistglance(mcdonaldfqas) ```

Similar functions are provided for handling transect assessments. For those sets, physiognometric information can also be extracted.

```{r tidying2}

obtain a data frame with species data for a downloaded transect assessment:

surveyspecies <- transectinventory(rock_garden)

obtain a data frame with physiognometric data for a downloaded transect assessment:

surveyphys <- transectphys(rock_garden)

obtain a data frame with summary information for a downloaded transect assessment:

rockgardensummary <- transectglance(rockgarden)

obtain a data frame with summary information for multiple downloaded transect assessments:

lordsummary <- transectlistglance(lordfqas) ```

Analytic functions

As of version 0.3.0, ${\tt fqar}$ includes tools for analyzing species co-occurrence across multiple floristic quality assessments. A typical workflow consists of downloading a list of assessments, extracting inventories from each, then enumerating and summarizing co-occurrences of the species of interest.

```{r analysis}

Obtain a tidy data frame of all co-occurrences in the 1995 Southern Ontario database:

ontario <- downloadassessmentlist(database = 2)

Extract inventories as a list:

ontarioinvs <- assessmentlist_inventory(ontario)

Enumerate all co-occurrences in this database:

ontariocooccurrences <- assessmentcooccurrences(ontario_invs)

Sumamrize co-occurrences in this database, one row per target species:

ontariocooccurrences <- assessmentcooccurrencessummary(ontarioinvs) ```

Of particular note is the species_profile() function, which returns the frequency distribution of C-values of co-occurring species for a given target species.

{r profile} aster_profile <- species_profile("Aster lateriflorus", ontario_invs)

Learn More

  • Read the ${\tt fqar}$ vignette to learn how to download and analyze FQAs with fqar.
  • View the help files of any function in the ${\tt fqar}$ package for more examples.

Contribute

To contribute to ${\tt fqar}$ you can fork this repository and create pull requests to add features you think will be useful for users. You can also open an issue if you find a bug or wish to make a suggestion.

Owner

  • Name: Andrew Gard
  • Login: equitable-equations
  • Kind: user
  • Location: Lake Forest, IL

Check me out on YouTube or come see me in person at Lake Forest College, where I teach data science and do all sorts of cool research.

JOSS Publication

The fqar package: R tools for analyzing floristic quality assessment data
Published
April 23, 2024
Volume 9, Issue 96, Page 6366
Authors
Andrew Gard ORCID
Lake Forest College, Lake Forest IL, USA
Alexia Myers
Lake Forest College, Lake Forest IL, USA
Irene Luwabelwa
Lake Forest College, Lake Forest IL, USA
Editor
Michael Mahoney ORCID
Tags
ecology floristic quality assessment

GitHub Events

Total
  • Issues event: 1
  • Push event: 6
Last Year
  • Issues event: 1
  • Push event: 6

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 408
  • Total Committers: 4
  • Avg Commits per committer: 102.0
  • Development Distribution Score (DDS): 0.012
Past Year
  • Commits: 21
  • Committers: 1
  • Avg Commits per committer: 21.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
equitable-equations a****d@l****u 403
ireneluwa i****a@g****m 3
DavisVaughan d****s@r****m 1
Alexia Myers 1****s 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 11
  • Total pull requests: 6
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 6 days
  • Total issue authors: 3
  • Total pull request authors: 4
  • Average comments per issue: 2.09
  • Average comments per pull request: 0.5
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: 10 days
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 2.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • ifoxfoot (5)
  • mhesselbarth (5)
  • teunbrand (1)
Pull Request Authors
  • ireneluwa (3)
  • mikemahoney218 (1)
  • alexiamyers (1)
  • DavisVaughan (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • cran 418 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 13
  • Total maintainers: 1
proxy.golang.org: github.com/equitable-equations/fqar
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
cran.r-project.org: fqar

Floristic Quality Assessment Tools for R

  • Versions: 12
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 418 Last month
Rankings
Forks count: 17.8%
Dependent packages count: 29.8%
Stargazers count: 35.2%
Dependent repos count: 35.5%
Average: 40.5%
Downloads: 84.1%
Maintainers (1)
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • R >= 4.1.0 depends
  • dplyr * imports
  • jsonlite * imports
  • rlang * imports
  • tidyr * imports
  • ggplot2 * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • testthat * suggests
.github/workflows/.draft-pdf.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 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