From d727646d3ce04bb5ac4c7419db801b0266f7c919 Mon Sep 17 00:00:00 2001 From: Thomas Mailund Date: Sat, 13 Aug 2016 13:18:45 +0200 Subject: [PATCH] minor reformatting --- NAMESPACE | 4 ++-- R/conversion.R | 6 +++--- man/Math.units.Rd | 2 +- man/Ops.units.Rd | 6 ++++-- man/as.dt.Rd | 2 +- man/as.units.Rd | 2 +- man/as.units.difftime.Rd | 2 +- man/{units-set-.numeric.Rd => units-set.Rd} | 12 +++++++----- man/units.Rd | 4 ++-- man/units.units.Rd | 2 +- units.Rproj | 1 + 11 files changed, 24 insertions(+), 19 deletions(-) rename man/{units-set-.numeric.Rd => units-set.Rd} (58%) diff --git a/NAMESPACE b/NAMESPACE index a64359d8..2525f71b 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,8 +1,6 @@ # Generated by roxygen2: do not edit by hand S3method("[",units) -S3method("units<-",numeric) -S3method("units<-",units) S3method(Math,units) S3method(Ops,units) S3method(Summary,units) @@ -17,6 +15,8 @@ S3method(print,units) S3method(quantile,units) S3method(units,units) S3method(weighted.mean,units) +export("units<-") +export("units<-.units") export(as.dt) export(as.units) import(stats) diff --git a/R/conversion.R b/R/conversion.R index bcdfbc7d..0950f1a4 100644 --- a/R/conversion.R +++ b/R/conversion.R @@ -8,7 +8,7 @@ NULL #' Set measurement units on a numeric vector #' #' @param x numeric vector -#' @param value character; valid unit of measurement string +#' @param value character; unit of measurement string #' #' @return object of class \code{units} #' @export @@ -20,10 +20,10 @@ NULL #' class(x) #' y = 2:5 #' try(units(y) <- "xxy") # error -`units<-.numeric` = function(x, value) { +`units<-.numeric` = function(x, strict.ud = FALSE, value) { stopifnot(is.character(value)) if (!ud.is.parseable(value)) - stop(paste(value, "not recognized as a unit of measurement")) + stop(paste(value, "not recognized as a udunits2 unit of measurement")) attr(x, "units") = value class(x) = "units" x diff --git a/man/Math.units.Rd b/man/Math.units.Rd index 990db522..8d073355 100644 --- a/man/Math.units.Rd +++ b/man/Math.units.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/arith.R +% Please edit documentation in R/math.R \name{Math.units} \alias{Math.units} \title{Mathematical operations for units objects} diff --git a/man/Ops.units.Rd b/man/Ops.units.Rd index ad8a5ccd..85e3ba15 100644 --- a/man/Ops.units.Rd +++ b/man/Ops.units.Rd @@ -7,9 +7,11 @@ \method{Ops}{units}(e1, e2) } \arguments{ -\item{e1}{object of class \code{units}, or something that can be coerced to it by \code{as.units(e1)}} +\item{e1}{object of class \code{units}, +or something that can be coerced to it by \code{as.units(e1)}} -\item{e2}{object of class \code{units}, or something that can be coerced to it by \code{as.units(e2)}} +\item{e2}{object of class \code{units}, +or something that can be coerced to it by \code{as.units(e2)}} } \value{ object of class \code{units} diff --git a/man/as.dt.Rd b/man/as.dt.Rd index a992f987..af4ecabe 100644 --- a/man/as.dt.Rd +++ b/man/as.dt.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/arith.R +% Please edit documentation in R/conversion.R \name{as.dt} \alias{as.dt} \title{convert units object into difftime object} diff --git a/man/as.units.Rd b/man/as.units.Rd index 534ba747..e613406e 100644 --- a/man/as.units.Rd +++ b/man/as.units.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/arith.R +% Please edit documentation in R/conversion.R \name{as.units} \alias{as.units} \title{convert object to a units object} diff --git a/man/as.units.difftime.Rd b/man/as.units.difftime.Rd index 4b54827b..836019f8 100644 --- a/man/as.units.difftime.Rd +++ b/man/as.units.difftime.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/arith.R +% Please edit documentation in R/conversion.R \name{as.units.difftime} \alias{as.units.difftime} \title{convert difftime objects to units} diff --git a/man/units-set-.numeric.Rd b/man/units-set.Rd similarity index 58% rename from man/units-set-.numeric.Rd rename to man/units-set.Rd index 3126933c..d5314d0b 100644 --- a/man/units-set-.numeric.Rd +++ b/man/units-set.Rd @@ -1,15 +1,17 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/arith.R -\name{units<-.numeric} -\alias{units<-.numeric} +% Please edit documentation in R/conversion.R +\name{units<-} +\alias{units<-} \title{Set measurement units on a numeric vector} \usage{ -\method{units}{numeric}(x) <- value +units(x, strict.ud = FALSE) <- value } \arguments{ \item{x}{numeric vector} -\item{value}{character; valid unit of measurement string} +\item{value}{character; unit of measurement string} + +\item{strict.ud}{boolean; must the unit be valid as a udunit2 measurment?} } \value{ object of class \code{units} diff --git a/man/units.Rd b/man/units.Rd index 7222463a..70e7fcaa 100644 --- a/man/units.Rd +++ b/man/units.Rd @@ -1,11 +1,11 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/arith.R +% Please edit documentation in R/conversion.R \name{units} \alias{units} \alias{units<-.units} \title{Convert units} \usage{ -\method{units}{units}(x) <- value +units.units(x) <- value } \arguments{ \item{x}{object of class \code{units}} diff --git a/man/units.units.Rd b/man/units.units.Rd index 2edc1fdd..6ba060fa 100644 --- a/man/units.units.Rd +++ b/man/units.units.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/arith.R +% Please edit documentation in R/conversion.R \name{units.units} \alias{units.units} \title{retrieve measurement units from units object} diff --git a/units.Rproj b/units.Rproj index b1ded457..9f964990 100644 --- a/units.Rproj +++ b/units.Rproj @@ -15,3 +15,4 @@ LaTeX: pdfLaTeX BuildType: Package PackageUseDevtools: Yes PackageInstallArgs: --no-multiarch --with-keep.source +PackageRoxygenize: rd,collate,namespace