-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
95 lines (72 loc) · 3.52 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file and click on Knit button at the end. -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
options(tibble.print_min = 5, tibble.print_max = 5)
```
# rwptool R package <a href='https://ob7-ird.github.io/rwptool'><img src='man/figures/logo_rwptool.png' align="right" /></a>
<!-- badges: start -->
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://github.com/OB7-IRD/acdc/actions)
[](https://CRAN.R-project.org/package=rwptool)
<!-- badges: end -->
***Regional Work Plans Tool***
## Warning
Package and documentation still in construction !
## Overview
R toolbox package for the EU Regional Work Plans development.
## Installation
```{r, eval = FALSE}
devtools::install_github("https://github.com/OB7-IRD/rwptool",
INSTALL_opts=c("--no-multiarch"))
```
### Development version
To get a bug fix or to use a feature from the development version, you can install the development version of rwptool from GitHub.
```{r, eval = FALSE}
devtools::install_github("https://github.com/OB7-IRD/rwptool",
ref = "development",
INSTALL_opts=c("--no-multiarch"))
```
## Cheatsheet
Working in progress for this section. Be patient.
## Usage
```{r, message = FALSE, eval = FALSE}
# setup ----
library(rwptool)
reference_period_start <- as.integer(x = 2019)
reference_period_end <- as.integer(x = 2021)
# By default countries used are the 27 EU member states, you can change that through the "eu_countries" argument.
# By default rfmo used are CCAMLR, CECAF, GFCM, IATTC, ICCAT, ICES, IOTC, NAFO, SEAFO, SPRFMO, WCPFC and WECAFC. You can change that through the "rfmo" argument.
landing_statistics <- "eurostat"
# You can switch with "rcg_stats" in the "landing_statistics" argument to use regional database source.
input_path_directory_eurostat <- "~/eurostat"
input_path_file_rcg_stats <- "~/cl_landing_rdbes.csv"
input_path_file_fides <- "~/export_quota.csv"
output_path <- "~/output"
# process ----
# with eurostat data as input
rwp_table_2_1_template(reference_period_start = reference_period_start,
reference_period_end = reference_period_end,
landing_statistics = landing_statistics,
input_path_directory_eurostat = input_path_directory_eurostat,
input_path_file_fides = input_path_file_fides,
output_path = output_path)
# with rcg stats data as input
rwp_table_2_1_template(reference_period_start = reference_period_start,
reference_period_end = reference_period_end,
landing_statistics = landing_statistics,
input_path_file_rcg_stats = input_path_file_rcg_stats,
input_path_file_fides = input_path_file_fides,
output_path = output_path)
```
## Getting help
If you encounter a clear bug, please file an issue with a minimal reproducible example on [GitHub issues page](https://github.com/OB7-IRD/rwptool/issues). This link is also available if you have any questions and improvement propositions.
## References
Working in progress for this section.