Skip to content

Commit

Permalink
add some notes about #253
Browse files Browse the repository at this point in the history
  • Loading branch information
Enchufa2 committed Nov 7, 2020
1 parent cc1911f commit 701226c
Showing 2 changed files with 23 additions and 2 deletions.
12 changes: 11 additions & 1 deletion R/arith.R
Original file line number Diff line number Diff line change
@@ -5,7 +5,17 @@

#' S3 Ops Group Generic Functions for units objects
#'
#' Ops functions for units objects, including comparison, product and divide, add, subtract
#' Ops functions for units objects, including comparison, product and divide,
#' add, subtract.
#'
#' Users are advised against performing arithmetical operations with
#' temperatures in different units. The \pkg{units} package ensure that results
#' 1) are arithmetically correct, and 2) satisfy dimensional analysis, but could
#' never ensure that results are physically meaningful. Temperature units are
#' special because there is an absolute unit, Kelvin, and relative ones, Celsius
#' and Fahrenheit degrees. Arithmetic operations between them are meaningless
#' from the physical standpoint. Users are thus advised to convert all
#' temperatures to Kelvin before operating.
#'
#' @param e1 object of class \code{units},
#' or something that can be coerced to it by \code{as_units(e1)}
13 changes: 12 additions & 1 deletion man/Ops.units.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 701226c

Please sign in to comment.