Skip to content

Improve description of nan= and fill= in ?nafill, include example #7186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jangorecki merged 3 commits into from
Aug 30, 2025
Merged

Improve description of nan= and fill= in ?nafill, include example #7186

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
038ae8f
Improve description of nan=
MichaelChirico Jul 17, 2025
f0ed80b
Also clarify how fill= works in locf
MichaelChirico Jul 17, 2025
06bf1b4
Also link ?fcoalesce
MichaelChirico Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions man/nafill.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@
Fast fill missing values using constant value, \emph{last observation carried forward} or \emph{next observation carried backward}.
}
\usage{
nafill(x, type=c("const","locf","nocb"), fill=NA, nan=NA)
setnafill(x, type=c("const","locf","nocb"), fill=NA, nan=NA, cols=seq_along(x))
nafill(x, type=c("const", "locf", "nocb"), fill=NA, nan=NA)
setnafill(x, type=c("const", "locf", "nocb"), fill=NA, nan=NA, cols=seq_along(x))
}
\arguments{
\item{x}{ vector, list, data.frame or data.table of numeric columns. }
\item{type}{ character, one of \emph{"const"}, \emph{"locf"} or \emph{"nocb"}. Defaults to \code{"const"}. }
\item{fill}{ numeric or integer, value to be used to fill. }
\item{nan}{ (numeric \code{x} only) Either \code{NaN} or \code{NA}; if the former, \code{NaN} is treated as distinct from \code{NA}, otherwise, they are treated the same during replacement? }
\item{cols}{ numeric or character vector specifying columns to be updated. }
\item{x}{ Vector, list, data.frame or data.table of numeric columns. }
\item{type}{ Character, one of \emph{"const"}, \emph{"locf"} or \emph{"nocb"}. Defaults to \code{"const"}. }
\item{fill}{ Numeric value to be used to replace missing observations. See examples. }
\item{nan}{ Either \code{NaN} or \code{NA}; if the former, \code{NaN} is treated as distinct from \code{NA}, otherwise, they are treated the same during replacement. See Examples. }
\item{cols}{ Numeric or character vector specifying columns to be updated. }
}
\details{
Only \emph{double} and \emph{integer} data types are currently supported.
Expand All @@ -33,13 +33,21 @@ x = 1:10
x[c(1:2, 5:6, 9:10)] = NA
nafill(x, "locf")

x = c(1, NA, NaN, 3, NaN, NA, 4)
nafill(x, "locf")
nafill(x, "locf", nan=NaN)
Comment thread
MichaelChirico marked this conversation as resolved.

# fill= applies to any leftover NA
nafill(c(NA, x), "locf")
nafill(c(NA, x), "locf", fill=0)

dt = data.table(v1=x, v2=shift(x)/2, v3=shift(x, -1L)/2)
nafill(dt, "nocb")

setnafill(dt, "locf", cols=c("v2","v3"))
dt
}
\seealso{
\code{\link{shift}}, \code{\link{data.table}}
\code{\link{shift}}, \code{\link{data.table}}, \code{\link{fcoalesce}}
}
\keyword{ data }
Loading