File: shouldPrint.Rd

package info (click to toggle)
r-cran-data.table 1.14.8%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 15,936 kB
  • sloc: ansic: 15,680; sh: 100; makefile: 6
file content (25 lines) | stat: -rw-r--r-- 705 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
\name{shouldPrint}
\alias{shouldPrint}
\title{ For use by packages that mimic/divert auto printing e.g. IRkernel and knitr }
\description{
  Not for use by users. Exported only for use by IRkernel (Jupyter) and knitr.
}
\usage{
  shouldPrint(x)
}
\arguments{
  \item{x}{ A \code{data.table}. }
}
\details{
  Should IRkernel/Jupyter print a data.table returned invisibly by DT[,:=] ?
  This is a read-once function since it resets an internal flag. If you need the value more than once in your logic, store the value from the first call.
}
\value{
  TRUE or FALSE.
}
\references{
  \url{https://github.com/IRkernel/IRkernel/issues/127}\cr
  \url{https://github.com/Rdatatable/data.table/issues/933}\cr
}