Skip to content
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

Jump to bottom

avoid with=FALSE in doc example #5594

Merged
merged 3 commits into from
Dec 14, 2023
Merged

avoid with=FALSE in doc example #5594

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fcc2964
avoid with=FALSE in doc example
MichaelChirico Feb 15, 2023
1813f67
Use Tyson suggestion
MichaelChirico Dec 14, 2023
b884e22
Merge branch 'master' into MichaelChirico-patch-10
MichaelChirico Dec 14, 2023
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
Prev Previous commit
Next Next commit
Use Tyson suggestion
  • Loading branch information
@MichaelChirico
MichaelChirico authored Dec 14, 2023
commit 1813f6772fcc0ac102a920a29dce0d274a1bb61c
2 changes: 1 addition & 1 deletion man/setcolorder.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ setcolorder(x, neworder=key(x), before=NULL, after=NULL)
\item{before, after}{ If one of them (not both) was provided with a column name or number, \code{neworder} will be inserted before or after that column. }
}
\details{
To reorder \code{data.table} columns, the idiomatic way is to use \code{setcolorder(x, neworder)}, instead of doing \code{x <- x[, ..neworder]}. This is because the latter makes an entire copy of the \code{data.table}, which maybe unnecessary in most situations. \code{setcolorder} also allows column numbers instead of names for \code{neworder} argument, although we recommend using names as a good programming practice.
To reorder \code{data.table} columns, the idiomatic way is to use \code{setcolorder(x, neworder)}, instead of doing \code{x <- x[, ..neworder]} (or \code{x <- x[, neworder, with=FALSE]}). This is because the latter makes an entire copy of the \code{data.table}, which maybe unnecessary in most situations. \code{setcolorder} also allows column numbers instead of names for \code{neworder} argument, although we recommend using names as a good programming practice.
}
\value{
The input is modified by reference, and returned (invisibly) so it can be used in compound statements. If you require a copy, take a copy first (using \code{DT2 = copy(DT)}). See \code{?copy}.
Expand Down
Loading