File: countLines.Rd

package info (click to toggle)
r-cran-r.utils 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,864 kB
  • sloc: sh: 18; makefile: 6
file content (54 lines) | stat: -rw-r--r-- 1,326 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
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  countLines.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{countLines}
\alias{countLines.default}
\alias{countLines}

\title{Counts the number of lines in a text file}

\description{
 Counts the number of lines in a text file by counting the number of occurrences of platform-independent
 newlines (CR, LF, and CR+LF [1]), including a last line with neither.
 An empty file has zero lines.
}

\usage{
\method{countLines}{default}(file, chunkSize=5e+07, ...)
}

\arguments{
  \item{file}{A \code{\link[base:connections]{connection}} or a pathname.}
  \item{chunkSize}{The number of bytes read in each chunk.}
  \item{...}{Not used.}
}

\value{
  Returns an non-negative \code{\link[base]{integer}}.
}

\details{
  Both compressed and non-compressed files are supported.
}

\author{Henrik Bengtsson}

\examples{
pathname <- system.file("NEWS.md", package="R.utils");
n <- countLines(pathname);
n2 <- length(readLines(pathname));
stopifnot(n == n2);
}

\references{
  [1] Page \emph{Newline}, Wikipedia, July 2008.
      \url{https://en.wikipedia.org/wiki/Newline}
}


\keyword{programming}