Skip to content

Commit 285c00d

Browse files
committed
minor fix of documentation
1 parent e481115 commit 285c00d

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

R/pressurepath_create.R

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
#' before and after. `pressurepath_create()` does not return measurement for stationary periods
2222
#' which are not provided in `path` as well as the flight before and after.
2323
#'
24-
#' `pressurepath_create()` also return the altitude of the bird along its trajectory. The altitude
24+
#' also return the altitude of the bird along its trajectory. The altitude
2525
#' \eqn{z_{tag}} (a.s.l.) is computed from the tag pressure \eqn{P_{tag}}, using the barometric
2626
#' equation \deqn{ z_{{tag}}(x)=z_{ERA5}(x) + \frac{T_{ERA5}(x)}{L_b} \left(
2727
#' \frac{P_{tag}}{P_{ERA5}(x)} \right)^{\frac{RL_b}{g M}-1},}
@@ -37,6 +37,10 @@
3737
#' \deqn{ P_{ERA5,0}(\boldsymbol{x})[t] = \left( P_{ERA5}(\boldsymbol{x})[t]-P_{tag}[t]\right) -
3838
#' \left( \frac{1}{n}\sum_{i=1}^{n} P_{ERA5}(\boldsymbol{x})[i]-P_{tag}[i] \right).}
3939
#'
40+
#' `pressurepath_create()` also computes the local sunrise and sunset times for each timestep
41+
#' according to the position of the path using `path2twilight()`. Sunrise and sunset are defined
42+
#' by the solar depression angle `solar_dep`.
43+
#'
4044
#' @param tag a GeoPressureR `tag` object.
4145
#' @param path a GeoPressureR `path` data.frame.
4246
#' @param variable ERA5 variable/parameters available to download.

man/pressurepath_create.Rd

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)