File: use_data_table.Rd

package info (click to toggle)
r-cran-usethis 3.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,228 kB
  • sloc: sh: 26; makefile: 17; cpp: 6; ansic: 3
file content (19 lines) | stat: -rw-r--r-- 958 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/data-table.R
\name{use_data_table}
\alias{use_data_table}
\title{Prepare for importing data.table}
\usage{
use_data_table()
}
\description{
\code{use_data_table()} imports the \code{data.table()} function from the data.table
package, as well as several important symbols: \verb{:=}, \code{.SD}, \code{.BY}, \code{.N},
\code{.I}, \code{.GRP}, \code{.NGRP}, \code{.EACHI}. This is a minimal setup and you can learn
much more in the "Importing data.table" vignette:
\verb{https://rdatatable.gitlab.io/data.table/articles/datatable-importing.html}.
In addition to importing these functions, \code{use_data_table()} also blocks the
usage of data.table in the \code{Depends} field of the \code{DESCRIPTION} file;
\code{data.table} should be used as an \emph{imported} or \emph{suggested} package only. See
this \href{https://github.com/Rdatatable/data.table/issues/3076}{discussion}.
}