Skip to content

Commit

Permalink
version 0.2.4
Browse files Browse the repository at this point in the history
  • Loading branch information
@ricschuster @cran-robot
ricschuster authored and cran-robot committed Aug 5, 2020
1 parent c97a751 commit c87ecb4
Show file tree
Hide file tree
Showing 14 changed files with 213 additions and 189 deletions.
74 changes: 42 additions & 32 deletions DESCRIPTION
View file
@@ -1,43 +1,53 @@
Package: prioritizrdata
Type: Package
Version: 0.2.2
Title: Conservation Planning Data Sets
Description: Conservation planning data sets for learning how to use the 'prioritizr' package <https://CRAN.R-project.org/package=prioritizr>.
Authors@R: c(person(c('Jeffrey', 'O'), 'Hanson',
email='jeffrey.hanson@uqconnect.edu.au', role = c('aut')),
person(c('Richard'), 'Schuster',
email='mail@richard-schuster.com', role = c('aut', 'cre')),
person(c('Nina'), 'Morrell',
email='nina.morrell@ubc.ca', role = c('aut')),
person(c('Matthew'), 'Strimas-Mackey',
email='mstrimas@gmail.com', role = c('aut')),
person(c('Matthew', 'E'), 'Watts',
email='m.watts@uq.edu.au', role = c('aut')),
person(c('Peter'), 'Arcese',
email='peter.arcese@ubc.ca', role = c('aut')),
person(c('Joeseph'), 'Bennett',
email='joseph.bennett@carleton.ca', role = c('aut')),
person(c('Hugh', 'P'), 'Possingham',
email='hugh.possingham@tnc.org', role = c('aut')))
Suggests: testthat, roxygen2, knitr, rgeos
Depends: R(>= 3.4.0), raster, sp
Version: 0.2.4
Title: Conservation Planning Datasets
Description: Conservation planning datasets for learning how to use the
'prioritizr' package <https://CRAN.R-project.org/package=prioritizr>.
Authors@R:
c(person(c('Jeffrey', 'O'), 'Hanson',
email='jeffrey.hanson@uqconnect.edu.au', role = c('aut'),
comment = c(ORCID = '0000-0002-4716-6134')),
person(c('Richard'), 'Schuster',
email='richard.schuster@glel.carleton.ca', role = c('aut', 'cre'),
comment = c(ORCID = '0000-0003-3191-7869')),
person(c('Nina'), 'Morrell',
email='nina.morrell@ubc.ca', role = c('aut')),
person(c('Matthew'), 'Strimas-Mackey',
email='mstrimas@gmail.com', role = c('aut'),
comment = c(ORCID = '0000-0001-8929-7776')),
person(c('Matthew', 'E'), 'Watts',
email='m.watts@uq.edu.au', role = c('aut')),
person(c('Peter'), 'Arcese',
email='peter.arcese@ubc.ca', role = c('aut'),
comment = c(ORCID = '0000-0002-8097-482X')),
person(c('Joseph'), 'Bennett',
email='joseph.bennett@carleton.ca', role = c('aut'),
comment = c(ORCID = '0000-0002-3901-9513')),
person(c('Hugh', 'P'), 'Possingham',
email='hugh.possingham@tnc.org', role = c('aut'),
comment = c(ORCID = '0000-0001-7755-996X')))
Suggests: testthat, roxygen2, knitr, rgeos, rgdal
Depends: R(>= 3.5.0), raster, sp
License: GPL-3
Encoding: UTF-8
LazyData: true
URL: https://prioritizr.github.io/prioritizrdata,
Language: en-US
URL: https://prioritizr.github.io/prioritizrdata/,
https://github.com/prioritizr/prioritizrdata
BugReports: https://github.com/prioritizr/prioritizrdata/issues
RoxygenNote: 6.0.1
RoxygenNote: 7.1.1
Collate: 'package.R' 'salt_data.R' 'tas_data.R'
NeedsCompilation: no
Packaged: 2018-05-22 03:38:05 UTC; richard
Author: Jeffrey O Hanson [aut],
Richard Schuster [aut, cre],
Packaged: 2020-08-04 22:24:52 UTC; richard
Author: Jeffrey O Hanson [aut] (<https://orcid.org/0000-0002-4716-6134>),
Richard Schuster [aut, cre] (<https://orcid.org/0000-0003-3191-7869>),
Nina Morrell [aut],
Matthew Strimas-Mackey [aut],
Matthew Strimas-Mackey [aut] (<https://orcid.org/0000-0001-8929-7776>),
Matthew E Watts [aut],
Peter Arcese [aut],
Joeseph Bennett [aut],
Hugh P Possingham [aut]
Maintainer: Richard Schuster <mail@richard-schuster.com>
Peter Arcese [aut] (<https://orcid.org/0000-0002-8097-482X>),
Joseph Bennett [aut] (<https://orcid.org/0000-0002-3901-9513>),
Hugh P Possingham [aut] (<https://orcid.org/0000-0001-7755-996X>)
Maintainer: Richard Schuster <richard.schuster@glel.carleton.ca>
Repository: CRAN
Date/Publication: 2018-05-22 10:13:01 UTC
Date/Publication: 2020-08-05 09:50:02 UTC
26 changes: 13 additions & 13 deletions MD5
View file
@@ -1,16 +1,16 @@
f27ee2eb6cc0a4c67a2e752647013064 *DESCRIPTION
f00a20a08292cfbdad036bd351b42ab6 *DESCRIPTION
97eef920da71adc5c98418bde4ae3766 *NAMESPACE
cd574126eafbde024d5046d6823e3fc4 *R/package.R
f56f455474d8a95a1d9658b29803d28d *R/salt_data.R
b567da32d3c64a0d94d8945c201b67ef *R/tas_data.R
572228b89d3c881e869a7a7011507653 *README.md
e65a1350f67ec7fa5ebc19a4d5b50f24 *data/salt_features.rda
d41ebd063c30530f2bbcea7b2438282b *data/salt_pu.rda
119e2fddccd3356fe6d2c40d7e58ea80 *data/tas_features.rda
62aced74e4b900a733656984777349e4 *data/tas_pu.rda
84d947bef70edf098757a4a801988e1d *man/prioritizrdata.Rd
c49d4ef32f8c93efdd56627531675f97 *man/salt_data.Rd
dc1684a28abd1da360bc4b4b23080b3b *man/tas_data.Rd
3744ba90211f90b6b7cfc3c3e0898fb2 *R/package.R
70abdac74932d074b0e98f556ed06ef0 *R/salt_data.R
f80ba535b837b6b619a85b14999097e4 *R/tas_data.R
b174b016e0df6d7b25002a3cf2cedd30 *README.md
0f1ac6614708d1d379419f45d1d42181 *data/salt_features.rda
957e1c560fedbaae812b89f1fc6fc05c *data/salt_pu.rda
4875117f4a31a83865267497e98fea90 *data/tas_features.rda
aa6885e16efb37e2029582d610da1a86 *data/tas_pu.rda
ac0ae36c5a0f7038b1f22dafb16ecda0 *man/prioritizrdata.Rd
6e747562daedcc1669aa87aff3d0da9e *man/salt_data.Rd
828cf22343dfa6f4051d5b85f5956ce2 *man/tas_data.Rd
d626732a2c961e8ea54334b77aa4db4b *tests/testthat.R
a8ca43e92c0e18c767198fba701311aa *tests/testthat/test_salt_data.R
1c93d441b8c49960f1be88c8520df28b *tests/testthat/test_tas_data.R
ae875a4fdab5ebf259e7c8551bc3194c *tests/testthat/test_tas_data.R
22 changes: 11 additions & 11 deletions R/package.R
View file
Expand Up @@ -2,12 +2,12 @@
#' @import sp
NULL

#' \pkg{prioritizrdata}: Conservation Planning Data Sets
#' prioritizrdata: Conservation Planning Datasets
#'
#' The \pkg{prioritizrdata} package is a supplemental package that contains
#' example datasets for conservation planning. It is intended to be used
#' example datasets for conservation planning. It is intended to be used
#' alongside the
#' \href{https://github.com/prioritizr/prioritizr}{\pkg{prioritizr} package}---a
#' \href{https://CRAN.R-project.org/package=prioritizr}{\pkg{prioritizr} package}---a
#' package for building and solving systematic conservation prioritization
#' problems using integer linear programming (ILP) techniques---and provides
#' little functionality itself.
Expand All @@ -16,22 +16,22 @@ NULL
#'
#' \describe{
#'
#' \item{\code{\link{tas_data}}}{This data set was obtained from the
#' \href{http://marxan.net/courses}{"Introduction to \emph{Marxan}" course}
#' \item{[tas_data]}{This dataset was obtained from the
#' ["Introduction to *Marxan*" course](https://marxansolutions.org/)
#' and was originally part of a larger spatial prioritization performed under
#' contract to Australia's Department of Environment and Water Resources.
#' This data set contains vector-based planning unit data and data for the
#' This dataset contains vector-based planning unit data and data for the
#' spatial distribution of 62 vegetation classes in Tasmania, Australia.
#' Refer to the Tasmania vignette in the \pkg{prioritizr} package for a
#' Refer to the [Tasmania vignette in the \pkg{prioritizr} package](https://CRAN.R-project.org/package=prioritizr/vignettes/tasmania.html) for a
#' worked example with this dataset.}
#'
#' \item{\code{\link{salt_data}}}{This dataset is from an
#' online \href{http://arcese.forestry.ubc.ca/marxan-tool}{\emph{Marxan}-based planning tool}
#' \item{[salt_data]}{This dataset is from an
#' online [*Marxan*-based planning tool](https://arcese.forestry.ubc.ca/marxan-tool/)
#' created for the Coastal Douglas-fir Conservation Partnership (CDFCP). It
#' contains raster-based planning unit data and the data for the spatial
#' distributions of five key ecological communities in the area. Refer to
#' the Salt Spring Island vignette in the \pkg{prioritizr} package for a
#' worked example with this dataset}
#' the [Salt Spring Island vignette in the \pkg{prioritizr} package](https://CRAN.R-project.org/package=prioritizr/vignettes/saltspring.html) for a
#' worked example with this dataset.}
#'
#' }
#'
Expand Down
53 changes: 25 additions & 28 deletions R/salt_data.R
View file
@@ -1,28 +1,27 @@
#' Salt Spring Island conservation planning data
#' Salt Spring Island data
#'
#' This data was obtained as part of an online \emph{Marxan}-based planning
#' This data was obtained as part of an online *Marxan*-based planning
#' tool created for the Coastal Douglas-fir Conservation Partnership
#' (CDFCP; Schuster \emph{et al.} 2017). For a worked example with this
#' dataset, refer to the \href{saltspring.html}{Salt Spring vignette}. The
#' scenario is intended to provide an example of how raster planning unit data
#' can be used in the \pkg{prioritizr} package.
#' (CDFCP; Schuster *et al.* 2017). For a worked example with this
#' dataset, refer to the [Salt Spring vignette in the \pkg{prioritizr} package](https://CRAN.R-project.org/package=prioritizr/vignettes/saltspring.html).
#'
#' @details
#' The data set contains the following items:
#' The dataset contains the following items:
#'
#' \describe{
#'
#' \item{\code{salt_pu}}{Planning unit data. A single band
#' \code{\link{RasterLayer-class}} object where each one hectare pixel
#' contains the monetary cost of acquiring the area (BC Land Assessment
#' \item{`salt_pu`}{Planning unit data. A single band
#' [`RasterLayer-class`] object where each one hectare pixel
#' describes the monetary cost of acquiring the area
#' (i.e. a pixel value of 1 = $100,000 CAD; BC Land Assessment
#' 2015).}
#'
#' \item{\code{salt_features}}{Biodiversity feature data. The probability of
#' occurrence commensal of five key ecological communities found on Salt
#' Spring island. Each layer in the \code{\link{RasterStack-class}}
#' object represents a different community type. These classes
#' are old forest (1), savanna (2), wetland (3), shrub (4), and a
#' layer representing the inverse probability of occurrence of human
#' \item{`salt_features`}{Biodiversity feature data. A multi-band
#' [`RasterStack-class`] object object containing the the probability of
#' occurrence for five key ecological communities found on Salt
#' Spring island. Each layer represents a different community type.
#' These classes are old forest (1), savanna (2), wetland (3), shrub (4),
#' and a layer representing the inverse probability of occurrence of human
#' commensal species (5). For a given layer, the values indicate the
#' composite probability of encountering the suite of bird species most
#' commonly associated with that community type.}
Expand All @@ -37,36 +36,34 @@
#' @usage data(salt_pu)
#'
#' @format \describe{
#' \item{salt_features}{\code{\link[raster]{RasterStack-class}} object}
#' \item{salt_pu}{\code{\link[raster]{RasterLayer-class}} object.}
#' \item{salt_features}{[`RasterStack-class`] object.}
#' \item{salt_pu}{[`RasterLayer-class`] object.}
#' }
#'
#' @keywords datasets
#'
#' @references
#' BC Assessment (2015) Property Information Services. Available at
#' \url{https://www.bcassessment.ca} [Date Accessed 2016/06/13].
#' <https://www.bcassessment.ca> (Date Accessed 2016/06/13).
#'
#' Morrell N, Schuster R, Crombie M, and Arcese P (2017) \emph{A Prioritization
#' Morrell N, Schuster R, Crombie M, and Arcese P (2017) *A Prioritization
#' Tool for the Conservation of Coastal Douglas-fir Forest and Savannah
#' Habitats of the Georgia Basin.} The Nature Trust of British Colombia, Coastal
#' Habitats of the Georgia Basin.* The Nature Trust of British Colombia, Coastal
#' Douglas Fir Conservation Partnership, and the Department of Forest and
#' Conservation Sciences, University of British Colombia. Available at
#' \url{http://peter-arcese-lab.sites.olt.ubc.ca/files/2016/09/CDFCP_tutorial_2017_05.pdf} [Date Accessed 2017/10/09].
#' <http://peter-arcese-lab.sites.olt.ubc.ca/files/2016/09/CDFCP_tutorial_2017_05.pdf> (Date Accessed 2017/10/09).
#'
#' @examples
#' # load data
#' data(salt_pu, salt_features)
#'
#' # preview data
#' print(salt_pu)
#' print(salt_features)
#'
#' # plot data
#' plot(salt_pu)
#' plot(salt_features)
#'
#' @name salt_data
NULL

#' @rdname salt_data
"salt_pu"

#' @rdname salt_data
"salt_features"
48 changes: 25 additions & 23 deletions R/tas_data.R
View file
@@ -1,24 +1,28 @@
#' Tasmanian conservation planning data
#' Tasmania data
#'
#' This data set was obtained from the
#' \href{http://marxan.net/courses}{"Introduction to \emph{Marxan}" course}
#' This dataset was obtained from the
#' ["Introduction to *Marxan*" course](https://marxansolutions.org/)
#' and was originally part of a larger spatial prioritization performed under
#' contract to Australia's Department of Environment and Water Resources
#' (Klein \emph{et al.} 2007).
#' (Klein *et al.* 2007). For a worked example with this
#' dataset, refer to the [Tasmania vignette in the \pkg{prioritizr} package](https://CRAN.R-project.org/package=prioritizr/vignettes/tasmania.html).
#'
#' @details The data set contains the following items:
#' @details The dataset contains the following items:
#'
#' \describe{
#'
#' \item{\code{tas_pu}}{Planning unit data. The attribute table has
#' three columns containing unique identifiers ("id"), unimproved land
#' values ("cost"), and their existing level of protection ("status").
#' Units with 50 \% or more of their area contained in protected areas
#' are associated with a status of 2, otherwise they are associated with a
#' value of 0.}
#' \item{`tas_pu`}{Planning unit data. The attribute table has
#' three columns containing unique identifiers (`"id"`),
#' unimproved land values (`"cost"`), and their existing level of
#' protection (`"status"`). Units with 50% or more of their area
#' contained in protected areas are associated with a status of 2,
#' otherwise they are associated with a value of 0.
#' It also contains columns (`"locked_in"` and `"locked_out"`)
#' with `logical` values (i.e. `TRUE` or `FALSE` values)
#' for locking in and locking out planning units.}
#'
#' \item{\code{tas_features}}{The distribution of 62 vegetation
#' classes in Tasmania, Australia. Each layer in the stack
#' \item{`tas_features`}{The distribution of 62 vegetation
#' classes in Tasmania, Australia. Each layer in the stack
#' represents a different vegetation class. For a given layer,
#' cells indicate the presence (value of 1) or absence (value of 0)
#' of the vegetation class in an area.}
Expand All @@ -33,32 +37,30 @@
#' @usage data(tas_pu)
#'
#' @format \describe{
#' \item{tas_features}{\code{\link[raster]{RasterStack-class}} object}
#' \item{tas_pu}{\code{\link[sp]{SpatialPolygonsDataFrame}} object.}
#' \item{tas_features}{[`RasterStack-class`] object}
#' \item{tas_pu}{[sp::SpatialPolygonsDataFrame()] object.}
#' }
#'
#' @keywords datasets
#'
#' @references
#' Klein C, Carwardine J, Wilson K, Watts M, and Possingham H (2007) \emph{Spatial
#' Klein C, Carwardine J, Wilson K, Watts M, and Possingham H (2007) *Spatial
#' Prioritization Approaches for the Conservation of Biodiversity in
#' Australia: Considering Conservation Costs, Ecological & Evolutionary
#' Processes, and Large-Intact Areas.} Report to the Department of
#' Processes, and Large-Intact Areas.* Report to the Department of
#' Environment; Water Resources.
#'
#' @examples
#' # load data
#' data(tas_pu, tas_features)
#'
#' # preview data
#' print(tas_pu)
#' print(tas_features)
#'
#' # plot data
#' plot(tas_pu)
#' plot(tas_features)
#'
#' @name tas_data
NULL

#' @rdname tas_data
"tas_pu"

#' @rdname tas_data
"tas_features"

0 comments on commit c87ecb4

Please sign in to comment.