File: pipe_arithmetic.Rd

package info (click to toggle)
r-cran-doby 4.7.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,400 kB
  • sloc: makefile: 2
file content (69 lines) | stat: -rw-r--r-- 1,390 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/pipe_friendly.R
\name{pipe_arithmetic}
\alias{pipe_arithmetic}
\alias{reciprocal}
\alias{pow}
\alias{add}
\alias{subtract}
\alias{mult}
\alias{divide}
\title{Pipe-friendly arithmetic helpers}
\usage{
reciprocal(x)

pow(x, p)

add(x, k)

subtract(x, k)

mult(x, k)

divide(x, k)
}
\arguments{
\item{x}{A numeric vector or scalar.}

\item{p}{A numeric scalar exponent (for \code{pow}).}

\item{k}{A numeric scalar for addition, subtraction, multiplication, or division.}
}
\value{
A numeric vector or scalar resulting from the transformation.
}
\description{
A set of simple, vectorized, pipe-friendly arithmetic functions for
transforming numeric data in pipelines. These helpers make common
operations like multiplication, division, addition, subtraction,
exponentiation, and reciprocals clearer when using the native pipe \verb{|>}.
}
\details{
All functions are vectorized and support numeric vectors, scalars, or compatible objects.
They are designed to improve the readability of transformation pipelines.
}
\examples{
x <- c(1, 2, 3)

# Multiplication and division
x |> mult(10)
x |> divide(2)

# Addition and subtraction
x |> add(5)
x |> subtract(1)

# Reciprocal
x |> reciprocal()

# Power
x |> pow(2)

# Combined use in pipelines
x |>
  mult(2) |>
  add(3) |>
  reciprocal()

}
\concept{pipe_arithmetic}