-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
104 lines (69 loc) · 5.04 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "inst/images/README-",
out.width = "100%"
)
library(badger)
```
# DiveR <img src="https://raw.githubusercontent.com/gowachin/DiveR/master/inst/images/DiveR_hex.png" alt="logo" align="right" height="200px/"/>
<!-- badges: start -->
[](https://www.tidyverse.org/lifecycle/#experimental) `r badge_devel("gowachin/DiveR", "blue")` [](https://github.com/gowachin/DiveR/actions) [](https://codecov.io/github/gowachin/DiveR?branch=master)
<!-- badges: end -->
R package for dive planification tools. It contains functions and methods to represent dive curves, desaturation time and gas consumption.
At this day, only mn90 tables models are coded for single, consecutive or successive dives. This mean all profile are square ones and only maximum depth and dive time are used to compute desaturation.
Future parts are work in progress, like more precise planification setup with different depths and time input. Desaturation planification with other models are also planned along with maybe other gas than air supported for consumption.
Intended to be used by french dive student, traduction of the lexic is on it's way.
Feel free to participate to this project, it is designed to be open source under a [CECILL-2 Licence](https://github.com/gowachin/DiveR/blob/master/LICENCE-CECILL-2.1.txt). Any help in traduction or documentation is welcome (see end of README).
## Installation
### Dependencies
This package relies on very few packages listed below, that you can install with the following code.
```{r, eval = FALSE}
for (i in c('graphics', 'stats', 'viridisLite') ){
if(!require(i,character.only = TRUE))
install.packages(i)
}
```
### Development version
You can install the development version of `{DiveR}` from [github](https://github.com/gowachin/DiveR) with:
```{r, eval = FALSE}
# install.packages("devtools")
devtools::install_github('https://github.com/gowachin/DiveR')
# or
# install.packages("remotes")
remotes::install_github("gowachin/DiveR")
```
<!--## Usage-->
This is a simple example where we simulate a dive. This show also the desaturation stops due in the table model.
```{r example_dive, dev='png', out.width="100%"}
# Simulation of a dive
library(DiveR)
dive <- dive(depth = 39, time = 22, secu = TRUE,
ascent_speed = 10, desat_model = "table")
summary(dive)
```
From the precedent dive you can check if you can survive with certain tank pressure.
```{r example_conso, dev='png', out.width="100%"}
tank <- tank(vol = 15, press = 230, name = "15L")
conso <- conso(dive = dive, tank = tank, cons = 20)
summary(conso)
plot(conso, line_print = FALSE)
```
## Documentation
For further information, check the vignettes describing above examples in more depth.
### Dive planification
Read [Dive planification](https://gowachin.github.io/DiveR/articles/dive_planif.html) Vignette to learn how to simulate dives under table desaturation model.
### Gas Consumption
Read [Gas Consumption](https://gowachin.github.io/DiveR/articles/gas_conso.html) Vignette to learn how to simulate the use of gas during a dive.
## Disclaimer
This application is intended for use in education about scubadiving planification and academic interest only. It is not designed for actual use in scuba diving and underwater activity. It is emphatically not suitable for use in actual diving. Scuba diving is a dangerous activity with risks of death and serious injury. No-one should attempt scuba diving without training, certification, supervision and regular medical assessment. It is also dangerous for trained scuba divers to exceed the limitations of their training.
This application will provide planification about dive profile and air consumption, without giving any warning if the activity would be dangerous or fatal. In doing so, it does not take account of safety restrictions, other physical laws, or other important information. Despite using diving table as base for computation, no output from this application should be misconstrued as a diving table. The author does not warrant that the application is correct in any sense whatsoever. Even if correctly computed, the predictions of a theoretical physical model may not be correct predictions.
Note here that all dives simulated will also being at sea level.
## Want to help ?
Go check the [projects](https://github.com/gowachin/DiveR/projects) of this repository ! Any help is welcome and I accept all sort of ideas for future project. The idea of this package is to learn about process like desaturation models and turn them into algorithms. If you want to use a specific model, join me and we can try to implement it !
Feel free to fork this, and use it. Any recommendation is welcome :)