You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
185 lines
9.6 KiB
185 lines
9.6 KiB
<!-- Generated by pkgdown: do not edit by hand -->
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Count lines of code, comments and whitespace in a package — cloc_pkg • cloc</title>
|
|
|
|
<!-- jquery -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
|
|
<!-- Bootstrap -->
|
|
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
|
|
|
|
<!-- Font Awesome icons -->
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" />
|
|
|
|
<!-- clipboard.js -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>
|
|
|
|
<!-- sticky kit -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>
|
|
|
|
<!-- pkgdown -->
|
|
<link href="../pkgdown.css" rel="stylesheet">
|
|
<script src="../pkgdown.js"></script>
|
|
|
|
|
|
|
|
<meta property="og:title" content="Count lines of code, comments and whitespace in a package — cloc_pkg" />
|
|
|
|
<meta property="og:description" content="Think of this as cloc() with saner defaults for packages. Skips common
|
|
IDE tempdirs, .git, inst, man." />
|
|
<meta name="twitter:card" content="summary" />
|
|
|
|
|
|
|
|
<!-- mathjax -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
<![endif]-->
|
|
|
|
|
|
</head>
|
|
|
|
<body>
|
|
<div class="container template-reference-topic">
|
|
<header>
|
|
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<span class="navbar-brand">
|
|
<a class="navbar-link" href="../index.html">cloc</a>
|
|
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.3.0</span>
|
|
</span>
|
|
</div>
|
|
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav">
|
|
<li>
|
|
<a href="../index.html">
|
|
<span class="fa fa-home fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../reference/index.html">Reference</a>
|
|
</li>
|
|
<li>
|
|
<a href="../news/index.html">Changelog</a>
|
|
</li>
|
|
</ul>
|
|
|
|
<ul class="nav navbar-nav navbar-right">
|
|
|
|
</ul>
|
|
|
|
</div><!--/.nav-collapse -->
|
|
</div><!--/.container -->
|
|
</div><!--/.navbar -->
|
|
|
|
|
|
</header>
|
|
|
|
<div class="row">
|
|
<div class="col-md-9 contents">
|
|
<div class="page-header">
|
|
<h1>Count lines of code, comments and whitespace in a package</h1>
|
|
|
|
<div class="hidden name"><code>cloc_pkg.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
|
|
<p>Think of this as <code><a href='cloc.html'>cloc()</a></code> with saner defaults for packages. Skips common
|
|
IDE tempdirs, <code>.git</code>, <code>inst</code>, <code>man</code>.</p>
|
|
|
|
</div>
|
|
|
|
<pre class="usage"><span class='fu'>cloc_pkg</span>(<span class='kw'>source</span> <span class='kw'>=</span> <span class='st'>"."</span>, <span class='kw'>extract_with</span> <span class='kw'>=</span> <span class='kw'>NULL</span>)</pre>
|
|
|
|
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
|
|
<table class="ref-arguments">
|
|
<colgroup><col class="name" /><col class="desc" /></colgroup>
|
|
<tr>
|
|
<th>source</th>
|
|
<td><p>file, directory or archive to read from (can be a valid URL)</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>extract_with</th>
|
|
<td><p>passed into <code>cloc</code> command line. This option is only
|
|
needed if cloc is unable to figure out how to extract the contents of
|
|
the input file(s) by itself.</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
|
|
|
|
<p>data frame (tibble)</p>
|
|
|
|
|
|
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
|
|
<pre class="examples"><div class='input'><span class='co'># by dir</span>
|
|
<span class='fu'><a href='cloc.html'>cloc</a></span>(<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/system.file'>system.file</a></span>(<span class='st'>"extdata"</span>, <span class='kw'>package</span><span class='kw'>=</span><span class='st'>"cloc"</span>))</div><div class='output co'>#> <span style='color: #949494;'># A tibble: 2 x 10</span><span>
|
|
#> source language file_count file_count_pct loc loc_pct blank_lines
|
|
#> </span><span style='color: #949494;font-style: italic;'><chr></span><span> </span><span style='color: #949494;font-style: italic;'><chr></span><span> </span><span style='color: #949494;font-style: italic;'><int></span><span> </span><span style='color: #949494;font-style: italic;'><dbl></span><span> </span><span style='color: #949494;font-style: italic;'><int></span><span> </span><span style='color: #949494;font-style: italic;'><dbl></span><span> </span><span style='color: #949494;font-style: italic;'><int></span><span>
|
|
#> </span><span style='color: #BCBCBC;'>1</span><span> extda… C++ 1 0.5 142 0.507 41
|
|
#> </span><span style='color: #BCBCBC;'>2</span><span> extda… R 1 0.5 138 0.493 24
|
|
#> </span><span style='color: #949494;'># … with 3 more variables: blank_line_pct </span><span style='color: #949494;font-style: italic;'><dbl></span><span style='color: #949494;'>, comment_lines </span><span style='color: #949494;font-style: italic;'><int></span><span style='color: #949494;'>,
|
|
#> # comment_line_pct </span><span style='color: #949494;font-style: italic;'><dbl></span><span></div><div class='input'>
|
|
<span class='co'># by file</span>
|
|
<span class='fu'><a href='cloc.html'>cloc</a></span>(<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/system.file'>system.file</a></span>(<span class='st'>"extdata"</span>, <span class='st'>"qrencoder.cpp"</span>, <span class='kw'>package</span><span class='kw'>=</span><span class='st'>"cloc"</span>))</div><div class='output co'>#> </span><span style='color: #949494;'># A tibble: 1 x 10</span><span>
|
|
#> source language file_count file_count_pct loc loc_pct blank_lines
|
|
#> </span><span style='color: #949494;font-style: italic;'><chr></span><span> </span><span style='color: #949494;font-style: italic;'><chr></span><span> </span><span style='color: #949494;font-style: italic;'><int></span><span> </span><span style='color: #949494;font-style: italic;'><dbl></span><span> </span><span style='color: #949494;font-style: italic;'><int></span><span> </span><span style='color: #949494;font-style: italic;'><dbl></span><span> </span><span style='color: #949494;font-style: italic;'><int></span><span>
|
|
#> </span><span style='color: #BCBCBC;'>1</span><span> qrenc… C++ 1 1 142 1 41
|
|
#> </span><span style='color: #949494;'># … with 3 more variables: blank_line_pct </span><span style='color: #949494;font-style: italic;'><dbl></span><span style='color: #949494;'>, comment_lines </span><span style='color: #949494;font-style: italic;'><int></span><span style='color: #949494;'>,
|
|
#> # comment_line_pct </span><span style='color: #949494;font-style: italic;'><dbl></span><span></div><div class='input'>
|
|
# requires a network connection therefore is set for you to run it manually
|
|
</div></span><span class='co'># NOT RUN {</span>
|
|
<span class='co'># from a url</span>
|
|
<span class='fu'><a href='cloc.html'>cloc</a></span>(<span class='st'>"https://rud.is/dl/cloc-1.74.tar.gz"</span>)
|
|
<span class='co'># }</span></pre>
|
|
</div>
|
|
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
|
|
<h2>Contents</h2>
|
|
<ul class="nav nav-pills nav-stacked">
|
|
<li><a href="#arguments">Arguments</a></li>
|
|
|
|
<li><a href="#value">Value</a></li>
|
|
|
|
<li><a href="#examples">Examples</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="copyright">
|
|
<p>Developed by Bob Rudis, Al Danial.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown">
|
|
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.3.0.</p>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|
|
|