Skip to content

Commit 2ff1d97

Browse files
committed
fixed spelling errors
1 parent a085954 commit 2ff1d97

14 files changed

+24
-24
lines changed

DESCRIPTION

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Package: S4DM
2-
Title: Small Sample Size Species Distribution Modelling
2+
Title: Small Sample Size Species Distribution Modeling
33
Version: 0.0.1
44
Authors@R:
55
c(
@@ -25,7 +25,7 @@ Authors@R:
2525
role = c("aut"),
2626
email = "cory.merow@gmail.com")
2727
)
28-
Description: This package implements multiple distribution modelling methods that are suited to species with small sample sizes (e.g., poorly sampled species or rare species).
28+
Description: This package implements multiple distribution modeling methods that are suited to species with small sample sizes (e.g., poorly sampled species or rare species).
2929
Depends:
3030
R (>= 3.5.0)
3131
License: MIT + file LICENSE

R/dr_maxnet.R

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
#'Density-ratio SDM estimation with MAXNET
1+
#'Density-ratio SDM estimation with Maxnet
22
#'
3-
#'dr_maxnet is an internal function for density-ratio estimation with MAXNET
3+
#'dr_maxnet is an internal function for density-ratio estimation with Maxnet
44
#' @param presence_data dataframe of covariates
55
#' @param background_data dataframe of covariates
66
#' @param projection_data dataframe of covariates
7-
#' @param f MAXNET formula to use. Default (NULL) will use the MAXNET default.
8-
#' @param regmult MAXNET regularization multiplier. Default is 1.
9-
#' @param regfun MAXNET regularization function. Default is the MAXNET default.
7+
#' @param f Maxnet formula to use. Default (NULL) will use the Maxnet default.
8+
#' @param regmult Maxnet regularization multiplier. Default is 1.
9+
#' @param regfun Maxnet regularization function. Default is the Maxnet default.
1010
#' @param addsamplestobackground If TRUE (the default), any presences that aren't in the background will be added.
1111
#' @param clamp If TRUE (the default), predictions will be limited to ranges seen in the training dataset.
1212
#' @param type Type of response required. Defaults to link, exponential, cloglog, and logistic.

R/ensemble_range_map.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
#' @note Either `method` or both `presence_method` and `background_method` must be supplied.
1919
#' @details Current plug-and-play methods include: "gaussian", "kde","vine","rangebagging", "lobagoc", and "none".
2020
#' Current density ratio methods include: "ulsif", "rulsif".
21-
#' @return List object containing elements (1) spatRaster ensemble layer showing the proportion of maps that are inclued in the range across the ensemble,
21+
#' @return List object containing elements (1) spatRaster ensemble layer showing the proportion of maps that are included in the range across the ensemble,
2222
#' (2) spatRasters for individual models, and (3) model quality information.
2323
#' @importFrom pROC roc auc
2424
#' @importFrom terra app nlyr ncell

R/evaluate_range_map.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#' @name evaluate_range_map
2-
#' @title Evalute PBSDM range map quality
2+
#' @title Evaluate PBSDM range map quality
33
#' @description This function uses 5-fold, spatially stratified, cross-validation to evaluate distribution model quality.
44
#' @param occurrences Presence coordinates in long,lat format.
55
#' @param env Environmental rasters

R/make_range_map.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
#' "numbag" (presence function is bootstrapped),
1111
#' or "doublebag" (presence and background functions are bootstrapped).
1212
#' @param bootstrap_reps Integer. Number of bootstrap replicates to use (default is 100)
13-
#' @param quantile Quantile to use for thresholding. Default is 0.05 (5 pct training presence). Set to 0 for minimum trainin presence (MTP), set to NULL to return continuous raster.
13+
#' @param quantile Quantile to use for thresholding. Default is 0.05 (5 pct training presence). Set to 0 for minimum training presence (MTP), set to NULL to return continuous raster.
1414
#' @param background_buffer_width The width (in m for unprojected rasters and map units for projected rasters) of the buffer to use for background data.
1515
#' Defaults to NULL, which will take the maximum distance between occurrence records.
1616
#' @param constraint_regions See get_env_bg documentation

R/pnp_lobagoc.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#' @name pnp_lobagoc
22
#' @title Internal function for fitting lobagoc distributions in plug-and-play SDMs.
3-
#' @description This function both fits lobgaoc distributions \insertCite{Drake2014-qz}{S4DM} and projects those distributions to new covariates.
3+
#' @description This function both fits lobagoc distributions \insertCite{Drake2014-qz}{S4DM} and projects those distributions to new covariates.
44
#' @param data dataframe of covariates
55
#' @param method one of either "fit" or "predict"
66
#' @param object fitted object returned by a pnp_... function. Only needed when method = "predict"

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Small Sample Size Species Distribution Modelling
1+
# Small Sample Size Species Distribution Modeling
22

33
## The S4DM R package
4-
This repository contains an R package that implements Species Distribution Modelling methods which work even when there are relatively few occurrence records (as is the case for poorly-sample or range-restricted species). These methods were primarily developed by the Drake lab, and include three types of methods: 1) Plug-and-play models, 2) environmental-range models, and 3) density-ratio models. Most of the important functions in this package are wrappers around existing functions that handle density estimation or density-ratio estimation. Much of this code was created by modifying existing code at https://github.com/DrakeLab/PlugNPlay in order to make functions more modular and extensible.
4+
This repository contains an R package that implements Species Distribution Modeling methods which work even when there are relatively few occurrence records (as is the case for poorly-sample or range-restricted species). These methods were primarily developed by the Drake lab, and include three types of methods: 1) Plug-and-play models, 2) environmental-range models, and 3) density-ratio models. Most of the important functions in this package are wrappers around existing functions that handle density estimation or density-ratio estimation. Much of this code was created by modifying existing code at https://github.com/DrakeLab/PlugNPlay in order to make functions more modular and extensible.
55

66
## How it works
77
The package is build on a hierarchy of modular functions, each of which calls on lower-level functions:

man/dr_maxnet.Rd

+5-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/ensemble_range_map.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/evaluate_range_map.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/make_range_map.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/pnp_lobagoc.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

old_builds/S4DM_0.0.1.tar.gz

3.54 KB
Binary file not shown.

vignettes/S4DM.Rmd

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This R package implements multiple species distribution modeling (SDM) methods t
2424

2525
### Plug-and-play models
2626

27-
The plug-and-play SDM framework was developed by Drake and Richards (2018). Plug-and-play models fit SDMs as the ratio of a presence distribution and a background distribution. Plug-and-play refers to the ability of the methodology to accommodate any method for estimating density functions (e.g., Gaussian, kernal-density estimation). Users are thus able to choose from multiple methods for estimating SDMs using an evolving set of methods within one unified framework.
27+
The plug-and-play SDM framework was developed by Drake and Richards (2018). Plug-and-play models fit SDMs as the ratio of a presence distribution and a background distribution. Plug-and-play refers to the ability of the methodology to accommodate any method for estimating density functions (e.g., Gaussian, kernel-density estimation). Users are thus able to choose from multiple methods for estimating SDMs using an evolving set of methods within one unified framework.
2828

2929
### Density-ratio models
3030

@@ -339,7 +339,7 @@ sample_points_gaussian_kde_predictions <- project_plug_and_play(pnp_model = samp
339339

340340
## Density-ratio models
341341

342-
In addition to methods that estimate the presence and background distributions separately, the package accommodates methods that directly estimate the density ratio, including uLSIF and MaxNet.
342+
In addition to methods that estimate the presence and background distributions separately, the package accommodates methods that directly estimate the density ratio, including uLSIF and Maxnet.
343343

344344
```{r maxnet}
345345

0 commit comments

Comments
 (0)