Two New Cumulative Sum Functions

[This article was first published on fishR Blog, and kindly contributed to R-bloggers]. (You can report issue about the content on this page here)
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.

In fisheries analysis it is fairly common to compute the cumulative sum of values in a vector – i.e., all values before and including the current position in the vector. For example, the third value in the cumulative sum would be the sum of the first, second, and third values in the original vector. These types of cumulative sums are easily accomplished with cumsum() in base R.

vec <- 1:10
( cum <- cumsum(vec) )
##  [1]  1  3  6 10 15 21 28 36 45 55
cum[3]
## [1] 6

Some applications in fisheries science (e.g., depletion estimators) require the cumulative sum NOT including the current value in the vector. For example, the third value in this case would be the sum of the first and second values in the original vector. These values can be computed by subtracting the original vector from the vector returned by cumsum().

cum-vec
##  [1]  0  1  3  6 10 15 21 28 36 45

For efficiency, this simple process has been coded in pcumsum() in FSA.

( pcum <- pcumsum(vec) )
##  [1]  0  1  3  6 10 15 21 28 36 45
pcum[3]
## [1] 3

In still other applications (e.g., proportional size distribution calculations) a cumulative sum from the LEFT rather than the right is required. For example, the third value in this case would be the sum of the third, fourth, fifth, …, last values in the original vector. These values can be computed by reversing the order of the result from cumsum() that had been applied to the reverse order of the original vector.

rev(cumsum(rev(vec)))
##  [1] 55 54 52 49 45 40 34 27 19 10

For efficiency, this simple process has been coded in rcumsum() in FSA.

( rcum <- rcumsum(vec) )
##  [1] 55 54 52 49 45 40 34 27 19 10
rcum[3]
## [1] 52

The three types of cumulative sums are shown, along with the original vector, in the matrix below.

cbind(vec,cum,pcum,rcum)
##       vec cum pcum rcum
##  [1,]   1   1    0   55
##  [2,]   2   3    1   54
##  [3,]   3   6    3   52
##  [4,]   4  10    6   49
##  [5,]   5  15   10   45
##  [6,]   6  21   15   40
##  [7,]   7  28   21   34
##  [8,]   8  36   28   27
##  [9,]   9  45   36   19
## [10,]  10  55   45   10

These two new functions are unlikely to change the world as we know it; however, I wanted to document them in this blog so that others could find them if needed.

To leave a comment for the author, please follow the link and comment on their blog: fishR Blog.

R-bloggers.com offers daily e-mail updates about R news and tutorials about learning R and many other topics. Click here if you're looking to post or find an R/data-science job.
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.

Never miss an update!
Subscribe to R-bloggers to receive
e-mails with the latest R posts.
(You will not see this message again.)

Click here to close (This popup will not appear again)