descent: Descent Rate or Time

View source: R/dive.R

descentR Documentation

Descent Rate or Time

Description

Specify an Descent Rate or Descent Time.

Usage

 descent(speed=NULL, time=NULL)

Arguments

speed

Descent rate in metres per minute. Incompatible with time.

time

Total descent time in minutes. Incompatible with speed.

Details

An object of class "rate" represents a diver's rate of ascent or descent, or the total time taken to ascend or descend. Such objects are useful in describing dives, especially in the function dive.

The value returned by descent represents a descent rate or descent time. Exactly one of the arguments speed and time should be given. If speed is given, this specifies a fixed rate of descent, in metres per minute. If time is given, this specifies a fixed total time of descent, in minutes.

Value

An object of class "rate" representing the descent rate or descent time.

Author(s)

\adrian

.

See Also

dive, descent

Examples

  # Descend at 30 metres/minute
  descent(30)
  # Descend in exactly 3 minutes
  descent(time=3)

scuba documentation built on Oct. 18, 2022, 5:06 p.m.