-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
133 lines (76 loc) · 4.14 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
---
output:
github_document:
html_preview: true
---
<!--
Copyright 2022 Province of British Columbia
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.
-->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# PEMr
<!-- badges: start -->
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
<!-- badges: end -->
## An R package to support Machine Learning Predictive Ecosystem Mapping (PEM)
This package comprises four modules to develop Predictive Ecosystem Mapping within British Columbia, using a machine-learning and data driven approach.
These include:
- `PEMprepr` : functions to prepare base data
- `PEMsamplr` : functions to create field sampling plans and format field data for modelling
- `PEMmodelr` : functions to optimise and generate machine learning models, and evaluate model accuracy statistics
- `PEMmapr`: functions to generate mapping products map production
The development of this methodology is currently in experimental phase and is under rapid development.
Predictive Ecosystem mapping in British Columbia is based on the [Biogeoclimatic Ecosystem Classification (BEC)](https://www.for.gov.bc.ca/hre/becweb/) system.
The broader **Predictive Ecosystem Mapping Methods Development project** is a collaboration of many partners including BC Ministry of Forests, BC Ministry of Lands, Water, and Resource Stewardship, BC Ministry of Environment, University of British Columbia, University of Northern British Columbia, Dalhousie University, Aleza Lake Research Forest, Thompson Rivers University, and OpenGeoHub.
### Installation
You can install `PEMr`development version from GitHub, using the [remotes](https://cran.r-project.org/package=remotes) package:
```{r eval=FALSE}
install.packages("remotes")
remotes::install_github("bcgov/PEMr")
library(PEMr)
```
### Vignettes
- [PEMprepr](https://github.com/bcgov/PEMprepr/blob/master/vignettes/PEMprepr.Rmd)
- How to prepare base data from ML-PEM mapping
- How to develop a sample plan (road)
- How to develop a sample plan (helicopter)
- How to process field collected data
- How to optimise models
### Project Status
This project is currently under rapid development. If you are interested in the work, please contact Genevieve Perkins ([email protected])
### Getting Help or Reporting an Issue
To report bugs/issues/feature requests, please file an [issue](https://github.com/bcgov/PEMr/issues/).
### How to Contribute
If you would like to contribute to the package, please see our
[CONTRIBUTING](CONTRIBUTING.md) guidelines.
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
### Citation
```{r, echo=FALSE, comment=""}
#citation("PEMr")
```
### License
```
Copyright 2022 Province of British Columbia
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.
```
---
*This project was created using the [bcgovr](https://github.com/bcgov/bcgovr) package.*