Data

Tools

Indexes

Applications

Experiments

Open Source Science

sgsr

https://github.com/tgoodbody/sgsr

Science Score: 49.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 2 DOI reference(s) in README
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 6 committers (16.7%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (20.5%) to scientific vocabulary
Last synced: 7 months ago · JSON representation

Repository

Basic Info
Statistics
  • Stars: 46
  • Watchers: 2
  • Forks: 8
  • Open Issues: 1
  • Releases: 11
Created almost 5 years ago · Last pushed 10 months ago
Metadata Files
Readme Changelog License

README.Rmd 

---
output: github_document
---



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

# sgsR - structurally guided sampling 


![license](https://img.shields.io/badge/Licence-GPL--3-blue.svg)
[![R-CMD-check](https://github.com/tgoodbody/sgsR/workflows/R-CMD-check/badge.svg)](https://github.com/tgoodbody/sgsR/actions)
[![Codecov test coverage](https://codecov.io/gh/tgoodbody/sgsR/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tgoodbody/sgsR?branch=main)
[![](https://cranlogs.r-pkg.org/badges/sgsR)](https://CRAN.R-project.org/package=sgsR)


## Installation :computer: {.unnumbered}

Install the stable version of [`sgsR`from CRAN](https://cran.r-project.org/package=sgsR) with:

``` r
install.packages("sgsR")
library(sgsR)
```

Install the most recent development version of [`sgsR` from Github](https://github.com/tgoodbody/sgsR) with:

``` r
install.packages("devtools")
devtools::install_github("https://github.com/tgoodbody/sgsR")
library(sgsR)
```
## Citing `sgsR` in literature

Open access publication: [sgsR: a structurally guided sampling toolbox for LiDAR-based forest inventories](https://doi.org/10.1093/forestry/cpac055)

To cite `sgsR` use `citation()` from within R with:

```{r}
print(citation("sgsR"), bibtex = TRUE)
```

## Overview

`sgsR` provides a collection of stratification and sampling algorithms that use auxiliary information for allocating sample units over an areal sampling frame. ALS metrics, like those derived from the [`lidR` package](https://cran.r-project.org/package=lidR) are the intended inputs.

Other remotely sensed or auxiliary data can also be used (e.g. optical satellite imagery, climate data, drone-based products).

`sgsR` is being actively developed, so you may encounter bugs. If that happens, [please report your issue here](https://github.com/tgoodbody/sgsR/issues) by providing a reproducible example.

## Example usage :bar_chart: {.unnumbered}

``` r
#--- Load mraster files ---#
r <- system.file("extdata", "mraster.tif", package = "sgsR")

#--- load the mraster using the terra package ---#
mraster <- terra::rast(r)

#--- apply quantiles algorithm to mraster ---#
sraster <- strat_quantiles(mraster = mraster$zq90, # use mraster as input for stratification
                           nStrata = 4) # produce 4 strata
                        
#--- apply stratified sampling ---#
existing <- sample_strat(sraster = sraster, # use sraster as input for sampling
                         nSamp = 200, # request 200 samples
                         mindist = 100, # samples must be 100 m apart
                         plot = TRUE) # plot output

```

## Resources & Vignettes :books: {.unnumbered}

Check out [the package documentation](https://tgoodbody.github.io/sgsR/index.html) to see how you can use `sgsR` functions for your work.

`sgsR` was presented at the ForestSAT 2022 Conference in Berlin. [Slides for the presentation can be found here.](https://tgoodbody.github.io/sgsR-ForestSAT2022/)

## Collaborators :woman: :man: {.unnumbered} 

We are thankful for continued collaboration with academic, private industry, and government institutions to help improve `sgsR`. Special thanks to to:

```{r,echo=FALSE, results = 'asis'}
library(knitr)
names <- c("Martin Queinnec", "Joanne C. White", "Piotr Tompalski", "Andrew T. Hudak", "Ruben Valbuena", "Antoine LeBoeuf", "Ian Sinclair", "Grant McCartney", "Jean-Francois Prieur", "Murray Woods")

aff <- c("University of British Columbia", "Canadian Forest Service", "Canadian Forest Service", "United States Forest Service", "Swedish University of Agricultural Sciences", "Ministère des Forêts, de la Faune et des Parcs", "Ministry of Northern Development, Mines, Natural Resources and Forestry", "Forsite Consultants Ltd.", "Université de Sherbrooke", " (Retired)	Ministry of Northern Development, Mines, Natural Resources and Forestry")

df <- data.frame(Collaborator = names, Affiliation = aff)

kable(df)
```


## Funding :raised_hands: {.unnumbered}
Development of `sgsR` was made possible thanks to the financial support of the Canadian Wood Fibre Centre's Forest Innovation Program.

Owner

  • Name: Tristan Goodbody
  • Login: tgoodbody
  • Kind: user
  • Location: Vancouver, Canada

GitHub Events

Total
  • Issues event: 4
  • Watch event: 2
  • Issue comment event: 5
  • Push event: 14
  • Pull request event: 2
Last Year
  • Issues event: 4
  • Watch event: 2
  • Issue comment event: 5
  • Push event: 14
  • Pull request event: 2

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 560
  • Total Committers: 6
  • Avg Commits per committer: 93.333
  • Development Distribution Score (DDS): 0.029
Past Year
  • Commits: 6
  • Committers: 2
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.167
Top Committers
Name Email Commits
Tristan Goodbody 6****y 544
evadChoi d****i@m****a 6
Nic s****s@h****t 4
Jean-Romain j****1@u****a 4
rhijmans r****s@g****m 1
Teun van den Brand t****d@g****m 1
Committer Domains (Top 20 + Academic)
ulaval.ca: 1 hotmail.it: 1 mail.ubc.ca: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 22
  • Total pull requests: 15
  • Average time to close issues: 23 days
  • Average time to close pull requests: 4 days
  • Total issue authors: 8
  • Total pull request authors: 6
  • Average comments per issue: 1.09
  • Average comments per pull request: 0.27
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 2
  • Average time to close issues: 1 day
  • Average time to close pull requests: about 1 month
  • Issue authors: 2
  • Pull request authors: 1
  • Average comments per issue: 1.5
  • Average comments per pull request: 1.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • tgoodbody (13)
  • spono (2)
  • rhijmans (2)
  • lukasjarron (1)
  • StumWhere (1)
  • ptompalski (1)
  • ttrotto (1)
  • jfprieur (1)
  • rymac17 (1)
Pull Request Authors
  • tgoodbody (7)
  • Jean-Romain (2)
  • teunbrand (2)
  • evadChoi (1)
  • rhijmans (1)
  • spono (1)
Top Labels
Issue Labels
bug (11) enhancement (4) invalid (2)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 265 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 11
  • Total maintainers: 1
cran.r-project.org: sgsR

Structurally Guided Sampling

  • Versions: 11
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 265 Last month
Rankings
Stargazers count: 7.8%
Forks count: 8.7%
Dependent repos count: 23.8%
Average: 24.7%
Dependent packages count: 28.6%
Downloads: 54.7%
Maintainers (1)
goodbody.t@gmail.com
Last synced: 10 months ago

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action 4.1.4 composite
  • actions/checkout 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/test-coverage.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • R >= 3.5.0 depends
  • methods * depends
  • BalancedSampling * imports
  • SamplingBigData * imports
  • clhs * imports
  • dplyr * imports
  • ggplot2 * imports
  • sf * imports
  • spatstat.geom * imports
  • terra * imports
  • tidyr * imports
  • RANN * suggests
  • Rfast * suggests
  • covr * suggests
  • doParallel * suggests
  • doSNOW * suggests
  • entropy * suggests
  • foreach * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • roxygen2 * suggests
  • snow * suggests
  • spelling * suggests
  • testthat >= 3.0.0 suggests