calcPercentile() refinements

[jack-davison]

This PR is a revision of calcPercentile().

New Features

• Added the type argument, consistent with timeAverage().

• Added the prefix argument, which allows users to define a different column name than percentile.XX.

• Added start.date and end.date, passed to timeAverage().

• The function will now error if a pollutant is not a column in mydata.

Bug Fixes

• There was this argument, start which wasn't doing anything. I assume it was meant to go to timeAverage(), so I've done that and renamed it to date.start.

Documentation

• Markdown roxygen2.

• Inherit param definitions from timeAverage().

• Added NEWS.md item.

Examples

devtools::load_all()
#> ℹ Loading openair

calcPercentile(mydata)
#> # A tibble: 90 × 2
#>    date                percentile.50
#>    <dttm>                      <dbl>
#>  1 1998-01-01 00:00:00             2
#>  2 1998-02-01 00:00:00             2
#>  3 1998-03-01 00:00:00             4
#>  4 1998-04-01 00:00:00             7
#>  5 1998-05-01 00:00:00             7
#>  6 1998-06-01 00:00:00             4
#>  7 1998-07-01 00:00:00            NA
#>  8 1998-08-01 00:00:00             4
#>  9 1998-09-01 00:00:00             4
#> 10 1998-10-01 00:00:00             4
#> # ℹ 80 more rows

calcPercentile(mydata, percentile = c(10, 50, 90), prefix = "p")
#> # A tibble: 90 × 4
#>    date                  p10   p50   p90
#>    <dttm>              <dbl> <dbl> <dbl>
#>  1 1998-01-01 00:00:00     0     2  12  
#>  2 1998-02-01 00:00:00     0     2   5  
#>  3 1998-03-01 00:00:00     1     4  12  
#>  4 1998-04-01 00:00:00     3     7  18  
#>  5 1998-05-01 00:00:00     2     7  20  
#>  6 1998-06-01 00:00:00     2     4  11.1
#>  7 1998-07-01 00:00:00    NA    NA  NA  
#>  8 1998-08-01 00:00:00     2     4  13  
#>  9 1998-09-01 00:00:00     1     4  12  
#> 10 1998-10-01 00:00:00     1     4  12.2
#> # ℹ 80 more rows

calcPercentile(mydata, pollutant = "noz")
#> Error in `calcPercentile()`:
#> ✖ pollutant 'noz' not present in data.
#> ℹ Columns in mydata: date, ws, wd, nox, no2, o3, pm10, so2, co, and pm25

calcPercentile(mydata, type = "wd")
#> Warning: 219 missing wind direction line(s) removed
#> # A tibble: 720 × 3
#>    date                wd    percentile.50
#>    <dttm>              <ord>         <dbl>
#>  1 1998-01-01 00:00:00 N               2  
#>  2 1998-02-01 00:00:00 N               1  
#>  3 1998-03-01 00:00:00 N               6  
#>  4 1998-04-01 00:00:00 N              14  
#>  5 1998-05-01 00:00:00 N              10  
#>  6 1998-06-01 00:00:00 N               5  
#>  7 1998-07-01 00:00:00 N              NA  
#>  8 1998-08-01 00:00:00 N               7.5
#>  9 1998-09-01 00:00:00 N               2  
#> 10 1998-10-01 00:00:00 N               4  
#> # ℹ 710 more rows

^{Created on 2025-02-01 with reprex v2.1.1}

[jack-davison]

Here's this 'start' argument, that seemingly never gets used.