New Upstream Snapshot - r-cran-here
Ready changes
Summary
Merged new upstream version: 1.0.1.9002 (was: 1.0.1).
Resulting package
Built on 2023-01-20T01:28 (took 8m59s)
The resulting binary packages can be installed (if you have the apt repository enabled) by running one of:
apt install -t fresh-snapshots r-cran-here
Lintian Result
Diff
diff --git a/DESCRIPTION b/DESCRIPTION
index 931e013..f794ac3 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,7 +1,7 @@
Package: here
Title: A Simpler Way to Find Your Files
-Version: 1.0.1
-Date: 2020-12-13
+Version: 1.0.1.9002
+Date: 2022-12-30
Authors@R:
c(person(given = "Kirill",
family = "M\u00fcller",
@@ -25,13 +25,11 @@ Suggests: conflicted, covr, fs, knitr, palmerpenguins, plyr, readr,
rlang, rmarkdown, testthat, uuid, withr
VignetteBuilder: knitr
Encoding: UTF-8
-LazyData: true
-RoxygenNote: 7.1.1.9000
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.2.3
Config/testthat/edition: 3
NeedsCompilation: no
-Packaged: 2020-12-13 06:59:33 UTC; kirill
+Packaged: 2023-01-20 01:24:25 UTC; root
Author: Kirill Müller [aut, cre] (<https://orcid.org/0000-0002-1416-3412>),
Jennifer Bryan [ctb] (<https://orcid.org/0000-0002-6983-2759>)
Maintainer: Kirill Müller <krlmlr+r@mailbox.org>
-Repository: CRAN
-Date/Publication: 2020-12-13 07:30:02 UTC
diff --git a/MD5 b/MD5
deleted file mode 100644
index 9640993..0000000
--- a/MD5
+++ /dev/null
@@ -1,48 +0,0 @@
-1b1db23b38394a0aac52a6f6f8f03444 *DESCRIPTION
-93f110026220b05597cb3940ecbfe868 *LICENSE
-5b2f2c6434205793ec20fbe7baf512a9 *NAMESPACE
-bafe0601cc5498da94d3d18c8ed6cee6 *NEWS.md
-4cc1335cbea7bb5e307e5689ce21e72f *R/aaa.R
-a521ceb1bbdb803feb7404c45f8a245b *R/dr_here.R
-9df5560100bc1ec088e8078a61af6681 *R/here.R
-9ae87370f123e7ab04e215ad29c3bf49 *R/i_am.R
-cf3551541b701c07ab5f41ea6102a897 *R/set_here.R
-10991e6728eb3e8f09eacbf3296c1532 *R/zzz.R
-9394d19a2f460f539bf3ff370c92d4a1 *README.md
-3aa9742f7421ea81e7b7e543930b0b86 *build/vignette.rds
-b721fca7668df666ae8ac753dd3e41b5 *inst/WORDLIST
-b296305f09e63870fa941b6b0d9076c6 *inst/demo-project/analysis/report.Rmd
-a06a0210251465a86fb970018292304d *inst/demo-project/data/penguins.csv
-3936ed002c1dd1fa5dc7a13d99d5df86 *inst/demo-project/demo-project.Rproj
-5d0a38962f43a5b84b2d406559bd3356 *inst/demo-project/prepare/penguins.R
-95519daa5c358e5917141af423fb51f6 *inst/doc/here.R
-84b9dd71253d5d3fb7974588ba4233fd *inst/doc/here.Rmd
-df8488f2a1be229413162d31d5f5a6c4 *inst/doc/here.html
-54359b28b572320694303359d7119c99 *inst/doc/rmarkdown.R
-255dc679ef919db654e7aced1a451f5b *inst/doc/rmarkdown.Rmd
-ce8e71fd52949054fa029b0aef3b9718 *inst/doc/rmarkdown.html
-350274d28873b0a5abd94476fc487f59 *man/dr_here.Rd
-cb1e46f469cfbbbde29c8b5113e1d789 *man/figures/lifecycle-archived.svg
-c0d2e5a54f1fa4ff02bf9533079dd1f7 *man/figures/lifecycle-defunct.svg
-a1b8c987c676c16af790f563f96cbb1f *man/figures/lifecycle-deprecated.svg
-c3978703d8f40f2679795335715e98f4 *man/figures/lifecycle-experimental.svg
-952b59dc07b171b97d5d982924244f61 *man/figures/lifecycle-maturing.svg
-27b879bf3677ea76e3991d56ab324081 *man/figures/lifecycle-questioning.svg
-6902bbfaf963fbc4ed98b86bda80caa2 *man/figures/lifecycle-soft-deprecated.svg
-53b3f893324260b737b3c46ed2a0e643 *man/figures/lifecycle-stable.svg
-1c1fe7a759b86dc6dbcbe7797ab8246c *man/figures/lifecycle-superseded.svg
-7633203d21049845349cd352c13ad250 *man/here.Rd
-5c9cf0465bded15f778a271c24787549 *man/i_am.Rd
-f226f75f898be3d2771df39616653b0b *man/set_here.Rd
-e6a18e8e7670512834be1f8b4403e05f *tests/testthat.R
-9d93a86c4f7238c660106e55db4375e5 *tests/testthat/_snaps/dr_here.md
-eff2e1be7e04f87e61d3df3c9e281a9d *tests/testthat/_snaps/i_am.md
-923b5820fbbd090b63de0cc21afcf7ad *tests/testthat/helper-expect.R
-ef7d5b1e0204b277a9f3301454d00715 *tests/testthat/helper-local.R
-64f7ae5ce41985b8793165a23a146dc6 *tests/testthat/setup.R
-131d197e51f962a26b368057bb396045 *tests/testthat/test-dr_here.R
-be418bf164890e06ce1bf7247b36d6ba *tests/testthat/test-here.R
-cb933152859f22e42605fc9807394abb *tests/testthat/test-i_am.R
-c129dbeafb921a052217dd91a28813b4 *tests/testthat/test-set_here.R
-84b9dd71253d5d3fb7974588ba4233fd *vignettes/here.Rmd
-255dc679ef919db654e7aced1a451f5b *vignettes/rmarkdown.Rmd
diff --git a/NEWS.md b/NEWS.md
index 12a7098..38b3813 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -1,3 +1,20 @@
+<!-- NEWS.md is maintained by https://cynkra.github.io/fledge, do not edit -->
+
+# here 1.0.1.9002 (2022-12-30)
+
+- Internal changes only.
+
+
+# here 1.0.1.9001 (2022-12-24)
+
+- Merge cran-1.0.1.
+
+
+# here 1.0.1.9000 (2020-12-13)
+
+- Adapt to testthat 3.0.1.
+
+
# here 1.0.1 (2020-12-13)
- Adapt to testthat 3.0.1.
diff --git a/README.md b/README.md
index 3233cb9..0681e25 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
<!-- badges: start -->
-[](https://www.tidyverse.org/lifecycle/#stable) [](https://github.com/r-lib/here/actions) [](https://CRAN.R-project.org/package=here) [](https://codecov.io/gh/r-lib/here?branch=master)
+[](https://www.tidyverse.org/lifecycle/#stable) [](https://github.com/r-lib/here/actions) [](https://CRAN.R-project.org/package=here) [](https://codecov.io/gh/r-lib/here?branch=main)
<!-- badges: end -->
@@ -34,7 +34,7 @@ You can build a path relative to the top-level directory in order to read or wri
<span class='c'>#> [1] "/home/kirill/git/R/here/inst/demo-project/data/penguins.csv"</span>
<span class='nf'>readr</span><span class='nf'>::</span><span class='nf'><a href='https://readr.tidyverse.org/reference/write_delim.html'>write_csv</a></span><span class='o'>(</span><span class='nf'>palmerpenguins</span><span class='nf'>::</span><span class='nv'><a href='https://allisonhorst.github.io/palmerpenguins/reference/penguins.html'>penguins</a></span>, <span class='nf'>here</span><span class='o'>(</span><span class='s'>"inst"</span>, <span class='s'>"demo-project"</span>, <span class='s'>"data"</span>, <span class='s'>"penguins.csv"</span><span class='o'>)</span><span class='o'>)</span></pre>
-These relative paths work regardless of where the associated source file lives inside your project, like analysis projects with data and reports in different subdirectories. See the included [demo project](https://github.com/r-lib/here/tree/master/inst/demo-project) for an example.
+These relative paths work regardless of where the associated source file lives inside your project, like analysis projects with data and reports in different subdirectories. See the included [demo project](https://github.com/r-lib/here/tree/main/inst/demo-project) for an example.
 *Illustration by [Allison Horst](https://github.com/allisonhorst)*
diff --git a/build/vignette.rds b/build/vignette.rds
index 388a4c8..66ecf32 100644
Binary files a/build/vignette.rds and b/build/vignette.rds differ
diff --git a/debian/changelog b/debian/changelog
index bf64d32..9c107b5 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+r-cran-here (1.0.1.9002-1) UNRELEASED; urgency=low
+
+ * New upstream release.
+
+ -- Debian Janitor <janitor@jelmer.uk> Fri, 20 Jan 2023 01:24:49 -0000
+
r-cran-here (1.0.1-2) unstable; urgency=medium
* Source-only upload
diff --git a/inst/doc/here.Rmd b/inst/doc/here.Rmd
index 0164b58..c283a3d 100644
--- a/inst/doc/here.Rmd
+++ b/inst/doc/here.Rmd
@@ -39,7 +39,7 @@ The project has the following structure:
fs::dir_tree(project_path)
```
-You can review the project on [GitHub](https://github.com/r-lib/here/tree/master/inst/demo-project) and also download a copy.
+You can review the project on [GitHub](https://github.com/r-lib/here/tree/main/inst/demo-project) and also download a copy.
To start working on this project in RStudio, open the `demo-project.Rproj` file.
This ensures that the [working directory](https://en.wikipedia.org/wiki/Working_directory) is set to `` `r project_path` ``, the project root.
diff --git a/inst/doc/here.html b/inst/doc/here.html
index f2b3a51..acb1f4a 100644
--- a/inst/doc/here.html
+++ b/inst/doc/here.html
@@ -38,11 +38,20 @@ document.addEventListener('DOMContentLoaded', function(e) {
</style>
-<style type="text/css">code{white-space: pre;}</style>
+
+<style type="text/css">
+ code {
+ white-space: pre;
+ }
+ .sourceCode {
+ overflow: visible;
+ }
+</style>
<style type="text/css" data-origin="pandoc">
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
+.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@@ -77,7 +86,7 @@ code span.al { color: #ff0000; font-weight: bold; } /* Alert */
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code span.at { color: #7d9029; } /* Attribute */
code span.bn { color: #40a070; } /* BaseN */
-code span.bu { } /* BuiltIn */
+code span.bu { color: #008000; } /* BuiltIn */
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code span.ch { color: #4070a0; } /* Char */
code span.cn { color: #880000; } /* Constant */
@@ -90,7 +99,7 @@ code span.er { color: #ff0000; font-weight: bold; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #40a070; } /* Float */
code span.fu { color: #06287e; } /* Function */
-code span.im { } /* Import */
+code span.im { color: #008000; font-weight: bold; } /* Import */
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
code span.op { color: #666666; } /* Operator */
@@ -111,13 +120,20 @@ code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warni
for (var i = 0; i < sheets.length; i++) {
if (sheets[i].ownerNode.dataset["origin"] !== "pandoc") continue;
try { var rules = sheets[i].cssRules; } catch (e) { continue; }
- for (var j = 0; j < rules.length; j++) {
+ var j = 0;
+ while (j < rules.length) {
var rule = rules[j];
// check if there is a div.sourceCode rule
- if (rule.type !== rule.STYLE_RULE || rule.selectorText !== "div.sourceCode") continue;
+ if (rule.type !== rule.STYLE_RULE || rule.selectorText !== "div.sourceCode") {
+ j++;
+ continue;
+ }
var style = rule.style.cssText;
// check if color or background-color is set
- if (rule.style.color === '' && rule.style.backgroundColor === '') continue;
+ if (rule.style.color === '' && rule.style.backgroundColor === '') {
+ j++;
+ continue;
+ }
// replace div.sourceCode by a pre.sourceCode rule
sheets[i].deleteRule(j);
sheets[i].insertRule('pre.sourceCode{' + style + '}', j);
@@ -325,118 +341,176 @@ code > span.er { color: #a61717; background-color: #e3d2d2; }
-<p>The here package enables easy file referencing by using the top-level directory of a file project to easily build file paths. This is in contrast to using <code>setwd()</code>, which is fragile and dependent on the way you order your files on your computer. Read more about project-oriented workflows:</p>
+<p>The here package enables easy file referencing by using the top-level
+directory of a file project to easily build file paths. This is in
+contrast to using <code>setwd()</code>, which is fragile and dependent
+on the way you order your files on your computer. Read more about
+project-oriented workflows:</p>
<ul>
-<li><p>What They Forgot to Teach You About R: <a href="https://rstats.wtf/project-oriented-workflow.html">“Project-oriented workflow”</a> chapter by Jenny Bryan and Jim Hester</p></li>
-<li><p><a href="https://www.tidyverse.org/blog/2017/12/workflow-vs-script/">“Project-oriented workflow”</a> blog post by Jenny Bryan</p></li>
-<li><p>R for data science: <a href="https://r4ds.had.co.nz/workflow-projects.html">“Workflow: projects”</a> chapter by Hadley Wickham</p></li>
+<li><p>What They Forgot to Teach You About R: <a href="https://rstats.wtf/project-oriented-workflow.html">“Project-oriented
+workflow”</a> chapter by Jenny Bryan and Jim Hester</p></li>
+<li><p><a href="https://www.tidyverse.org/blog/2017/12/workflow-vs-script/">“Project-oriented
+workflow”</a> blog post by Jenny Bryan</p></li>
+<li><p>R for data science: <a href="https://r4ds.had.co.nz/workflow-projects.html">“Workflow:
+projects”</a> chapter by Hadley Wickham</p></li>
</ul>
<div id="basic-functionality" class="section level2">
<h2>Basic functionality</h2>
-<p>For demonstration, this article uses a data analysis project that lives in <code>/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project</code> on my machine. This is the <em>project root</em>. The path will most likely be different on your machine, the here package helps deal with this situation.</p>
+<p>For demonstration, this article uses a data analysis project that
+lives in
+<code>/tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project</code> on my
+machine. This is the <em>project root</em>. The path will most likely be
+different on your machine, the here package helps deal with this
+situation.</p>
<p>The project has the following structure:</p>
-<pre><code>#> /tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project
-#> ├── analysis
-#> │ └── report.Rmd
-#> ├── data
-#> │ └── penguins.csv
-#> ├── demo-project.Rproj
-#> └── prepare
-#> └── penguins.R</code></pre>
-<p>You can review the project on <a href="https://github.com/r-lib/here/tree/master/inst/demo-project">GitHub</a> and also download a copy.</p>
-<p>To start working on this project in RStudio, open the <code>demo-project.Rproj</code> file. This ensures that the <a href="https://en.wikipedia.org/wiki/Working_directory">working directory</a> is set to <code>/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project</code>, the project root. Opening only the <code>.R</code> or the <code>.Rmd</code> file may be insufficient!</p>
-<p>Other development environments may have a different notion of a project. Either way, it is important that the working directory is set to the project root or a subdirectory of that path. You can check with:</p>
+<pre><code>#> /tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project
+#> +-- analysis
+#> | \-- report.Rmd
+#> +-- data
+#> | \-- penguins.csv
+#> +-- demo-project.Rproj
+#> \-- prepare
+#> \-- penguins.R</code></pre>
+<p>You can review the project on <a href="https://github.com/r-lib/here/tree/main/inst/demo-project">GitHub</a>
+and also download a copy.</p>
+<p>To start working on this project in RStudio, open the
+<code>demo-project.Rproj</code> file. This ensures that the <a href="https://en.wikipedia.org/wiki/Working_directory">working
+directory</a> is set to
+<code>/tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project</code>, the
+project root. Opening only the <code>.R</code> or the <code>.Rmd</code>
+file may be insufficient!</p>
+<p>Other development environments may have a different notion of a
+project. Either way, it is important that the working directory is set
+to the project root or a subdirectory of that path. You can check
+with:</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">setwd</span>(project_path)</span></code></pre></div>
<div class="sourceCode" id="cb3"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="fu">getwd</span>()</span>
-<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project"</span></span></code></pre></div>
-<p>(See <code>vignette("rmarkdown")</code> for an example where the working directory is set to a subdirectory on start.)</p>
+<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project"</span></span></code></pre></div>
+<p>(See <code>vignette("rmarkdown")</code> for an example where the
+working directory is set to a subdirectory on start.)</p>
<div id="declare-the-location-of-the-current-script" class="section level3">
<h3>Declare the location of the current script</h3>
-<p>The intended use is to add a call to <code>here::i_am()</code> at the beginning of your script or in the first chunk of your rmarkdown report.<a href="#fn1" class="footnote-ref" id="fnref1"><sup>1</sup></a> This achieves the following:</p>
+<p>The intended use is to add a call to <code>here::i_am()</code> at the
+beginning of your script or in the first chunk of your rmarkdown
+report.<a href="#fn1" class="footnote-ref" id="fnref1"><sup>1</sup></a>
+This achieves the following:</p>
<ul>
-<li>The location of the current script or report within the project is declared</li>
-<li>The project root is initialized, consistent with the location of the current script or report</li>
+<li>The location of the current script or report within the project is
+declared</li>
+<li>The project root is initialized, consistent with the location of the
+current script or report</li>
<li>An informative message is emitted.<a href="#fn2" class="footnote-ref" id="fnref2"><sup>2</sup></a></li>
</ul>
-<p>The first argument to <code>here::i_am()</code> should be the path to the current file, relative to the project root. The <code>penguins.R</code> script uses:</p>
+<p>The first argument to <code>here::i_am()</code> should be the path to
+the current file, relative to the project root. The
+<code>penguins.R</code> script uses:</p>
<div class="sourceCode" id="cb4"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a>here<span class="sc">::</span><span class="fu">i_am</span>(<span class="st">"prepare/penguins.R"</span>)</span>
-<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> here() starts at /tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project</span></span></code></pre></div>
-<p><code>here::i_am()</code> displays the top-level directory of the current project. Because the project has a <code>prepare/</code> directory in its root that contains <code>penguins.R</code>, it is correctly inferred as the project root.</p>
-<p>After <code>here::i_am()</code>, insert <code>library(here)</code> to make the <code>here()</code> function available:<a href="#fn3" class="footnote-ref" id="fnref3"><sup>3</sup></a></p>
+<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> here() starts at /tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project</span></span></code></pre></div>
+<p><code>here::i_am()</code> displays the top-level directory of the
+current project. Because the project has a <code>prepare/</code>
+directory in its root that contains <code>penguins.R</code>, it is
+correctly inferred as the project root.</p>
+<p>After <code>here::i_am()</code>, insert <code>library(here)</code> to
+make the <code>here()</code> function available:<a href="#fn3" class="footnote-ref" id="fnref3"><sup>3</sup></a></p>
<div class="sourceCode" id="cb5"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="fu">library</span>(here)</span></code></pre></div>
-<p>The top-level directory is also returned from the <code>here()</code> function:</p>
+<p>The top-level directory is also returned from the <code>here()</code>
+function:</p>
<div class="sourceCode" id="cb6"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="fu">here</span>()</span>
-<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project"</span></span></code></pre></div>
-<p>One important distinction from the working directory is that this remains stable even if the working directory is changed:</p>
+<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project"</span></span></code></pre></div>
+<p>One important distinction from the working directory is that this
+remains stable even if the working directory is changed:</p>
<div class="sourceCode" id="cb7"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="fu">setwd</span>(<span class="st">"analysis"</span>)</span>
<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a><span class="fu">getwd</span>()</span>
-<span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project/analysis"</span></span>
+<span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project/analysis"</span></span>
<span id="cb7-4"><a href="#cb7-4" aria-hidden="true" tabindex="-1"></a><span class="fu">here</span>()</span>
-<span id="cb7-5"><a href="#cb7-5" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project"</span></span>
+<span id="cb7-5"><a href="#cb7-5" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project"</span></span>
<span id="cb7-6"><a href="#cb7-6" aria-hidden="true" tabindex="-1"></a><span class="fu">setwd</span>(<span class="st">".."</span>)</span></code></pre></div>
-<p>(I suggest to steer clear from ever changing the working directory. This may not always be feasible, in particular if the working directory is changed by code that you do not control.)</p>
+<p>(I suggest to steer clear from ever changing the working directory.
+This may not always be feasible, in particular if the working directory
+is changed by code that you do not control.)</p>
</div>
<div id="use-project-relative-paths" class="section level3">
<h3>Use project-relative paths</h3>
-<p>You can build a path relative to the top-level directory in order to build the full path to a file:</p>
+<p>You can build a path relative to the top-level directory in order to
+build the full path to a file:</p>
<div class="sourceCode" id="cb8"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="fu">here</span>(<span class="st">"data"</span>, <span class="st">"penguins.csv"</span>)</span>
-<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project/data/penguins.csv"</span></span>
+<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project/data/penguins.csv"</span></span>
<span id="cb8-3"><a href="#cb8-3" aria-hidden="true" tabindex="-1"></a>readr<span class="sc">::</span><span class="fu">read_csv</span>(</span>
<span id="cb8-4"><a href="#cb8-4" aria-hidden="true" tabindex="-1"></a> <span class="fu">here</span>(<span class="st">"data"</span>, <span class="st">"penguins.csv"</span>),</span>
<span id="cb8-5"><a href="#cb8-5" aria-hidden="true" tabindex="-1"></a> <span class="at">col_types =</span> <span class="fu">list</span>(<span class="at">.default =</span> readr<span class="sc">::</span><span class="fu">col_guess</span>()),</span>
<span id="cb8-6"><a href="#cb8-6" aria-hidden="true" tabindex="-1"></a> <span class="at">n_max =</span> <span class="dv">3</span></span>
<span id="cb8-7"><a href="#cb8-7" aria-hidden="true" tabindex="-1"></a>)</span>
<span id="cb8-8"><a href="#cb8-8" aria-hidden="true" tabindex="-1"></a><span class="co">#> # A tibble: 3 x 8</span></span>
-<span id="cb8-9"><a href="#cb8-9" aria-hidden="true" tabindex="-1"></a><span class="co">#> species island bill_length_mm bill_depth_mm flipper_length_… body_mass_g sex </span></span>
-<span id="cb8-10"><a href="#cb8-10" aria-hidden="true" tabindex="-1"></a><span class="co">#> <chr> <chr> <dbl> <dbl> <dbl> <dbl> <chr></span></span>
-<span id="cb8-11"><a href="#cb8-11" aria-hidden="true" tabindex="-1"></a><span class="co">#> 1 Adelie Torge… 39.1 18.7 181 3750 male </span></span>
-<span id="cb8-12"><a href="#cb8-12" aria-hidden="true" tabindex="-1"></a><span class="co">#> 2 Adelie Torge… 39.5 17.4 186 3800 fema…</span></span>
-<span id="cb8-13"><a href="#cb8-13" aria-hidden="true" tabindex="-1"></a><span class="co">#> 3 Adelie Torge… 40.3 18 195 3250 fema…</span></span>
-<span id="cb8-14"><a href="#cb8-14" aria-hidden="true" tabindex="-1"></a><span class="co">#> # … with 1 more variable: year <dbl></span></span></code></pre></div>
-<p>This works regardless of where the associated source file lives inside your project. With <code>here()</code>, the path will always be relative to the top-level project directory.</p>
-<p><code>here()</code> works very similarly to <code>file.path()</code> or <code>fs::path()</code>, you can pass path components or entire subpaths:</p>
+<span id="cb8-9"><a href="#cb8-9" aria-hidden="true" tabindex="-1"></a><span class="co">#> species island bill_length_mm bill_depth_mm flipper_l~1 body_~2 sex year</span></span>
+<span id="cb8-10"><a href="#cb8-10" aria-hidden="true" tabindex="-1"></a><span class="co">#> <chr> <chr> <dbl> <dbl> <dbl> <dbl> <chr> <dbl></span></span>
+<span id="cb8-11"><a href="#cb8-11" aria-hidden="true" tabindex="-1"></a><span class="co">#> 1 Adelie Torgersen 39.1 18.7 181 3750 male 2007</span></span>
+<span id="cb8-12"><a href="#cb8-12" aria-hidden="true" tabindex="-1"></a><span class="co">#> 2 Adelie Torgersen 39.5 17.4 186 3800 fema~ 2007</span></span>
+<span id="cb8-13"><a href="#cb8-13" aria-hidden="true" tabindex="-1"></a><span class="co">#> 3 Adelie Torgersen 40.3 18 195 3250 fema~ 2007</span></span>
+<span id="cb8-14"><a href="#cb8-14" aria-hidden="true" tabindex="-1"></a><span class="co">#> # ... with abbreviated variable names 1: flipper_length_mm, 2: body_mass_g</span></span></code></pre></div>
+<p>This works regardless of where the associated source file lives
+inside your project. With <code>here()</code>, the path will always be
+relative to the top-level project directory.</p>
+<p><code>here()</code> works very similarly to <code>file.path()</code>
+or <code>fs::path()</code>, you can pass path components or entire
+subpaths:</p>
<div class="sourceCode" id="cb9"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="fu">here</span>(<span class="st">"data/penguins.csv"</span>)</span>
-<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project/data/penguins.csv"</span></span></code></pre></div>
-<p>As seen above, <code>here()</code> returns absolute paths (starting with <code>/</code>, <code><drive letter>:\</code> or <code>\\</code>). This makes it safe to pass these paths to other functions, even if the working directory is changed along the way.</p>
-<p>As of version 1.0.0, absolute paths passed to <code>here()</code> are returned unchanged. This means that you can safely use both absolute and project-relative paths in <code>here()</code>.</p>
+<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project/data/penguins.csv"</span></span></code></pre></div>
+<p>As seen above, <code>here()</code> returns absolute paths (starting
+with <code>/</code>, <code><drive letter>:\</code> or
+<code>\\</code>). This makes it safe to pass these paths to other
+functions, even if the working directory is changed along the way.</p>
+<p>As of version 1.0.0, absolute paths passed to <code>here()</code> are
+returned unchanged. This means that you can safely use both absolute and
+project-relative paths in <code>here()</code>.</p>
<div class="sourceCode" id="cb10"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a>data_path <span class="ot"><-</span> <span class="fu">here</span>(<span class="st">"data"</span>)</span>
<span id="cb10-2"><a href="#cb10-2" aria-hidden="true" tabindex="-1"></a><span class="fu">here</span>(data_path)</span>
-<span id="cb10-3"><a href="#cb10-3" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project/data"</span></span>
+<span id="cb10-3"><a href="#cb10-3" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project/data"</span></span>
<span id="cb10-4"><a href="#cb10-4" aria-hidden="true" tabindex="-1"></a><span class="fu">here</span>(data_path, <span class="st">"penguins.csv"</span>)</span>
-<span id="cb10-5"><a href="#cb10-5" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project/data/penguins.csv"</span></span></code></pre></div>
+<span id="cb10-5"><a href="#cb10-5" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project/data/penguins.csv"</span></span></code></pre></div>
</div>
<div id="situation-report" class="section level3">
<h3>Situation report</h3>
-<p>The <code>dr_here()</code> function explains the reasoning behind choosing the project root:</p>
+<p>The <code>dr_here()</code> function explains the reasoning behind
+choosing the project root:</p>
<div class="sourceCode" id="cb11"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="fu">dr_here</span>()</span>
-<span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> here() starts at /tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project.</span></span>
+<span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> here() starts at /tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project.</span></span>
<span id="cb11-3"><a href="#cb11-3" aria-hidden="true" tabindex="-1"></a><span class="co">#> - This directory contains a file "prepare/penguins.R"</span></span>
-<span id="cb11-4"><a href="#cb11-4" aria-hidden="true" tabindex="-1"></a><span class="co">#> - Initial working directory: /tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project</span></span>
-<span id="cb11-5"><a href="#cb11-5" aria-hidden="true" tabindex="-1"></a><span class="co">#> - Current working directory: /tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project</span></span></code></pre></div>
-<p>The <code>show_reason</code> argument can be set to <code>FALSE</code> to reduce the output to one line:</p>
+<span id="cb11-4"><a href="#cb11-4" aria-hidden="true" tabindex="-1"></a><span class="co">#> - Initial working directory: /tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project</span></span>
+<span id="cb11-5"><a href="#cb11-5" aria-hidden="true" tabindex="-1"></a><span class="co">#> - Current working directory: /tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project</span></span></code></pre></div>
+<p>The <code>show_reason</code> argument can be set to
+<code>FALSE</code> to reduce the output to one line:</p>
<div class="sourceCode" id="cb12"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a><span class="fu">dr_here</span>(<span class="at">show_reason =</span> <span class="cn">FALSE</span>)</span>
-<span id="cb12-2"><a href="#cb12-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> here() starts at /tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project</span></span></code></pre></div>
+<span id="cb12-2"><a href="#cb12-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> here() starts at /tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project</span></span></code></pre></div>
</div>
<div id="what-if-the-working-directory-is-wrong" class="section level3">
<h3>What if the working directory is wrong?</h3>
-<p>The declaration of the active file via <code>here::i_am()</code> also protects against accidentally running the script from a working directory outside of your project. The example below calls <code>here::i_am()</code> from the temporary directory, which is clearly outside our project:</p>
+<p>The declaration of the active file via <code>here::i_am()</code> also
+protects against accidentally running the script from a working
+directory outside of your project. The example below calls
+<code>here::i_am()</code> from the temporary directory, which is clearly
+outside our project:</p>
<div class="sourceCode" id="cb13"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a>withr<span class="sc">::</span><span class="fu">with_dir</span>(<span class="fu">tempdir</span>(), {</span>
<span id="cb13-2"><a href="#cb13-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">print</span>(<span class="fu">getwd</span>())</span>
<span id="cb13-3"><a href="#cb13-3" aria-hidden="true" tabindex="-1"></a> here<span class="sc">::</span><span class="fu">i_am</span>(<span class="st">"prepare/penguins.R"</span>)</span>
<span id="cb13-4"><a href="#cb13-4" aria-hidden="true" tabindex="-1"></a>})</span>
-<span id="cb13-5"><a href="#cb13-5" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpHuFWzz"</span></span>
+<span id="cb13-5"><a href="#cb13-5" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpLLLZu3"</span></span>
<span id="cb13-6"><a href="#cb13-6" aria-hidden="true" tabindex="-1"></a><span class="co">#> Error: Could not find associated project in working directory or any parent directory.</span></span>
<span id="cb13-7"><a href="#cb13-7" aria-hidden="true" tabindex="-1"></a><span class="co">#> - Path in project: prepare/penguins.R</span></span>
-<span id="cb13-8"><a href="#cb13-8" aria-hidden="true" tabindex="-1"></a><span class="co">#> - Current working directory: /tmp/RtmpHuFWzz</span></span>
+<span id="cb13-8"><a href="#cb13-8" aria-hidden="true" tabindex="-1"></a><span class="co">#> - Current working directory: /tmp/RtmpLLLZu3</span></span>
<span id="cb13-9"><a href="#cb13-9" aria-hidden="true" tabindex="-1"></a><span class="co">#> Please open the project associated with this file and try again.</span></span></code></pre></div>
-<p>This can also happen when a file has been renamed or moved without updating the <code>here::i_am()</code> call. In the future, a helper function will assist with installing and updating suitably formatted <code>here::i_am()</code> calls in your scripts and reports.</p>
+<p>This can also happen when a file has been renamed or moved without
+updating the <code>here::i_am()</code> call. In the future, a helper
+function will assist with installing and updating suitably formatted
+<code>here::i_am()</code> calls in your scripts and reports.</p>
</div>
</div>
<div id="extra-safety" class="section level2">
<h2>Extra safety</h2>
<div id="conflicts-with-other-packages" class="section level3">
<h3>Conflicts with other packages</h3>
-<p>Other packages also export a <code>here()</code> function. Loading these packages after loading here masks our <code>here()</code> function:</p>
+<p>Other packages also export a <code>here()</code> function. Loading
+these packages after loading here masks our <code>here()</code>
+function:</p>
<div class="sourceCode" id="cb14"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a><span class="fu">library</span>(plyr)</span>
<span id="cb14-2"><a href="#cb14-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> </span></span>
<span id="cb14-3"><a href="#cb14-3" aria-hidden="true" tabindex="-1"></a><span class="co">#> Attaching package: 'plyr'</span></span>
@@ -445,46 +519,61 @@ code > span.er { color: #a61717; background-color: #e3d2d2; }
<span id="cb14-6"><a href="#cb14-6" aria-hidden="true" tabindex="-1"></a><span class="co">#> here</span></span>
<span id="cb14-7"><a href="#cb14-7" aria-hidden="true" tabindex="-1"></a><span class="fu">here</span>()</span>
<span id="cb14-8"><a href="#cb14-8" aria-hidden="true" tabindex="-1"></a><span class="co">#> Error in here(): argument "f" is missing, with no default</span></span></code></pre></div>
-<p>One way to work around this problem is to use <code>here::here()</code>:</p>
+<p>One way to work around this problem is to use
+<code>here::here()</code>:</p>
<div class="sourceCode" id="cb15"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a>here<span class="sc">::</span><span class="fu">here</span>()</span>
-<span id="cb15-2"><a href="#cb15-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project"</span></span></code></pre></div>
-<p>The conflicted package offers an alternative: it detects that <code>here()</code> is exported from more than one package and allows you to use neither until you indicate a preference.</p>
+<span id="cb15-2"><a href="#cb15-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project"</span></span></code></pre></div>
+<p>The conflicted package offers an alternative: it detects that
+<code>here()</code> is exported from more than one package and allows
+you to use neither until you indicate a preference.</p>
<div class="sourceCode" id="cb16"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a><span class="fu">library</span>(conflicted)</span>
-<span id="cb16-2"><a href="#cb16-2" aria-hidden="true" tabindex="-1"></a><span class="fu">here</span>()</span>
-<span id="cb16-3"><a href="#cb16-3" aria-hidden="true" tabindex="-1"></a><span class="co">#> Error: [conflicted] `here` found in 2 packages.</span></span>
-<span id="cb16-4"><a href="#cb16-4" aria-hidden="true" tabindex="-1"></a><span class="co">#> Either pick the one you want with `::` </span></span>
-<span id="cb16-5"><a href="#cb16-5" aria-hidden="true" tabindex="-1"></a><span class="co">#> * plyr::here</span></span>
-<span id="cb16-6"><a href="#cb16-6" aria-hidden="true" tabindex="-1"></a><span class="co">#> * here::here</span></span>
-<span id="cb16-7"><a href="#cb16-7" aria-hidden="true" tabindex="-1"></a><span class="co">#> Or declare a preference with `conflict_prefer()`</span></span>
-<span id="cb16-8"><a href="#cb16-8" aria-hidden="true" tabindex="-1"></a><span class="co">#> * conflict_prefer("here", "plyr")</span></span>
-<span id="cb16-9"><a href="#cb16-9" aria-hidden="true" tabindex="-1"></a><span class="co">#> * conflict_prefer("here", "here")</span></span>
-<span id="cb16-10"><a href="#cb16-10" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb16-11"><a href="#cb16-11" aria-hidden="true" tabindex="-1"></a>conflicted<span class="sc">::</span><span class="fu">conflict_prefer</span>(<span class="st">"here"</span>, <span class="st">"here"</span>)</span>
-<span id="cb16-12"><a href="#cb16-12" aria-hidden="true" tabindex="-1"></a><span class="co">#> [conflicted] Will prefer here::here over any other package</span></span>
-<span id="cb16-13"><a href="#cb16-13" aria-hidden="true" tabindex="-1"></a><span class="fu">here</span>()</span>
-<span id="cb16-14"><a href="#cb16-14" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project"</span></span></code></pre></div>
+<span id="cb16-2"><a href="#cb16-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> Error in library(conflicted): there is no package called 'conflicted'</span></span>
+<span id="cb16-3"><a href="#cb16-3" aria-hidden="true" tabindex="-1"></a><span class="fu">here</span>()</span>
+<span id="cb16-4"><a href="#cb16-4" aria-hidden="true" tabindex="-1"></a><span class="co">#> Error in here(): argument "f" is missing, with no default</span></span>
+<span id="cb16-5"><a href="#cb16-5" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb16-6"><a href="#cb16-6" aria-hidden="true" tabindex="-1"></a>conflicted<span class="sc">::</span><span class="fu">conflict_prefer</span>(<span class="st">"here"</span>, <span class="st">"here"</span>)</span>
+<span id="cb16-7"><a href="#cb16-7" aria-hidden="true" tabindex="-1"></a><span class="co">#> Error in loadNamespace(x): there is no package called 'conflicted'</span></span>
+<span id="cb16-8"><a href="#cb16-8" aria-hidden="true" tabindex="-1"></a><span class="fu">here</span>()</span>
+<span id="cb16-9"><a href="#cb16-9" aria-hidden="true" tabindex="-1"></a><span class="co">#> Error in here(): argument "f" is missing, with no default</span></span></code></pre></div>
</div>
<div id="specify-a-unique-identifier" class="section level3">
<h3>Specify a unique identifier</h3>
-<p>To eliminate potential confusion, <code>here::i_am()</code> accepts a <code>uuid</code> argument. The idea is that each script and report calls <code>here::i_am()</code> very early (in the first 100 lines) with a universally unique identifier. Even if a file location is reused across projects (e.g. two projects contain a “prepare/data.R” file), the files can be identified correctly if the <code>uuid</code> argument in the <code>here::i_am()</code> call is different.</p>
-<p>If a <code>uuid</code> argument is passed to <code>here::i_am()</code>:</p>
+<p>To eliminate potential confusion, <code>here::i_am()</code> accepts a
+<code>uuid</code> argument. The idea is that each script and report
+calls <code>here::i_am()</code> very early (in the first 100 lines) with
+a universally unique identifier. Even if a file location is reused
+across projects (e.g. two projects contain a “prepare/data.R” file), the
+files can be identified correctly if the <code>uuid</code> argument in
+the <code>here::i_am()</code> call is different.</p>
+<p>If a <code>uuid</code> argument is passed to
+<code>here::i_am()</code>:</p>
<ul>
-<li>a project root that contains a file at the specified file path is searched</li>
+<li>a project root that contains a file at the specified file path is
+searched</li>
<li>the first 100 lines of that file are read</li>
-<li>for the correct file, the <code>here::i_am()</code> call that passes this very <code>uuid</code> is among those 100 lines, and will be matched</li>
+<li>for the correct file, the <code>here::i_am()</code> call that passes
+this very <code>uuid</code> is among those 100 lines, and will be
+matched</li>
<li>for the wrong file, <code>uuid</code> is not found in the text</li>
</ul>
-<p>Use <code>uuid::UUIDgenerate()</code> to create universally unique identifiers:</p>
+<p>Use <code>uuid::UUIDgenerate()</code> to create universally unique
+identifiers:</p>
<div class="sourceCode" id="cb17"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true" tabindex="-1"></a>uuid<span class="sc">::</span><span class="fu">UUIDgenerate</span>()</span>
-<span id="cb17-2"><a href="#cb17-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "36f421ac-2d53-46d4-bfad-a0ac96491443"</span></span></code></pre></div>
-<p>Ensure that the <code>uuid</code> arguments are actually unique across your files! In the future, a helper function will assist with installing and updating suitably formatted <code>here::i_am()</code> calls in your scripts and reports.</p>
+<span id="cb17-2"><a href="#cb17-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> Error in loadNamespace(x): there is no package called 'uuid'</span></span></code></pre></div>
+<p>Ensure that the <code>uuid</code> arguments are actually unique
+across your files! In the future, a helper function will assist with
+installing and updating suitably formatted <code>here::i_am()</code>
+calls in your scripts and reports.</p>
</div>
</div>
<div id="beyond-here" class="section level2">
<h2>Beyond here</h2>
<div id="change-project-root" class="section level3">
<h3>Change project root</h3>
-<p>It is advisable to <a href="https://rstats.wtf/save-source.html">start a fresh R session</a> as often as possible, especially before focusing on another project. There still may be legitimate cases when it is desirable to reset the project root.</p>
+<p>It is advisable to <a href="https://rstats.wtf/save-source.html">start a fresh R session</a>
+as often as possible, especially before focusing on another project.
+There still may be legitimate cases when it is desirable to reset the
+project root.</p>
<p>To start, let’s create a temporary project for demonstration:</p>
<div class="sourceCode" id="cb18"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb18-1"><a href="#cb18-1" aria-hidden="true" tabindex="-1"></a>temp_project_path <span class="ot"><-</span> <span class="fu">tempfile</span>()</span>
<span id="cb18-2"><a href="#cb18-2" aria-hidden="true" tabindex="-1"></a><span class="fu">dir.create</span>(temp_project_path)</span>
@@ -499,47 +588,66 @@ code > span.er { color: #a61717; background-color: #e3d2d2; }
<span id="cb18-11"><a href="#cb18-11" aria-hidden="true" tabindex="-1"></a> script_path</span>
<span id="cb18-12"><a href="#cb18-12" aria-hidden="true" tabindex="-1"></a>)</span>
<span id="cb18-13"><a href="#cb18-13" aria-hidden="true" tabindex="-1"></a>fs<span class="sc">::</span><span class="fu">dir_tree</span>(temp_project_path)</span>
-<span id="cb18-14"><a href="#cb18-14" aria-hidden="true" tabindex="-1"></a><span class="co">#> /tmp/RtmpHuFWzz/file30547d5e00ca</span></span>
-<span id="cb18-15"><a href="#cb18-15" aria-hidden="true" tabindex="-1"></a><span class="co">#> └── scripts</span></span>
-<span id="cb18-16"><a href="#cb18-16" aria-hidden="true" tabindex="-1"></a><span class="co">#> └── script.R</span></span>
+<span id="cb18-14"><a href="#cb18-14" aria-hidden="true" tabindex="-1"></a><span class="co">#> /tmp/RtmpLLLZu3/file6a5063355339</span></span>
+<span id="cb18-15"><a href="#cb18-15" aria-hidden="true" tabindex="-1"></a><span class="co">#> \-- scripts</span></span>
+<span id="cb18-16"><a href="#cb18-16" aria-hidden="true" tabindex="-1"></a><span class="co">#> \-- script.R</span></span>
<span id="cb18-17"><a href="#cb18-17" aria-hidden="true" tabindex="-1"></a><span class="fu">writeLines</span>(<span class="fu">readLines</span>(script_path))</span>
<span id="cb18-18"><a href="#cb18-18" aria-hidden="true" tabindex="-1"></a><span class="co">#> here::i_am("scripts/script.R")</span></span>
<span id="cb18-19"><a href="#cb18-19" aria-hidden="true" tabindex="-1"></a><span class="co">#> print("Hello, world!")</span></span></code></pre></div>
-<p>The <code>script.R</code> file contains a call to <code>here::i_am()</code> to declare its location. Running it from the current working directory will fail:</p>
+<p>The <code>script.R</code> file contains a call to
+<code>here::i_am()</code> to declare its location. Running it from the
+current working directory will fail:</p>
<div class="sourceCode" id="cb19"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb19-1"><a href="#cb19-1" aria-hidden="true" tabindex="-1"></a><span class="fu">source</span>(script_path, <span class="at">echo =</span> <span class="cn">TRUE</span>)</span>
<span id="cb19-2"><a href="#cb19-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> </span></span>
<span id="cb19-3"><a href="#cb19-3" aria-hidden="true" tabindex="-1"></a><span class="co">#> > here::i_am("scripts/script.R")</span></span>
<span id="cb19-4"><a href="#cb19-4" aria-hidden="true" tabindex="-1"></a><span class="co">#> Error: Could not find associated project in working directory or any parent directory.</span></span>
<span id="cb19-5"><a href="#cb19-5" aria-hidden="true" tabindex="-1"></a><span class="co">#> - Path in project: scripts/script.R</span></span>
-<span id="cb19-6"><a href="#cb19-6" aria-hidden="true" tabindex="-1"></a><span class="co">#> - Current working directory: /tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project</span></span>
+<span id="cb19-6"><a href="#cb19-6" aria-hidden="true" tabindex="-1"></a><span class="co">#> - Current working directory: /tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project</span></span>
<span id="cb19-7"><a href="#cb19-7" aria-hidden="true" tabindex="-1"></a><span class="co">#> Please open the project associated with this file and try again.</span></span></code></pre></div>
-<p>To reset the project root mid-session, change the working directory with <code>setwd()</code>. Now, the subsequent call to <code>here::i_am()</code> from within <code>script.R</code> works:</p>
+<p>To reset the project root mid-session, change the working directory
+with <code>setwd()</code>. Now, the subsequent call to
+<code>here::i_am()</code> from within <code>script.R</code> works:</p>
<div class="sourceCode" id="cb20"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb20-1"><a href="#cb20-1" aria-hidden="true" tabindex="-1"></a><span class="fu">setwd</span>(temp_project_path)</span></code></pre></div>
<div class="sourceCode" id="cb21"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb21-1"><a href="#cb21-1" aria-hidden="true" tabindex="-1"></a><span class="fu">source</span>(script_path, <span class="at">echo =</span> <span class="cn">TRUE</span>)</span>
<span id="cb21-2"><a href="#cb21-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> </span></span>
<span id="cb21-3"><a href="#cb21-3" aria-hidden="true" tabindex="-1"></a><span class="co">#> > here::i_am("scripts/script.R")</span></span>
-<span id="cb21-4"><a href="#cb21-4" aria-hidden="true" tabindex="-1"></a><span class="co">#> here() starts at /tmp/RtmpHuFWzz/file30547d5e00ca</span></span>
+<span id="cb21-4"><a href="#cb21-4" aria-hidden="true" tabindex="-1"></a><span class="co">#> here() starts at /tmp/RtmpLLLZu3/file6a5063355339</span></span>
<span id="cb21-5"><a href="#cb21-5" aria-hidden="true" tabindex="-1"></a><span class="co">#> </span></span>
<span id="cb21-6"><a href="#cb21-6" aria-hidden="true" tabindex="-1"></a><span class="co">#> > print("Hello, world!")</span></span>
<span id="cb21-7"><a href="#cb21-7" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "Hello, world!"</span></span></code></pre></div>
-<p>To reiterate: a fresh session is almost always the better, cleaner, safer, and more robust solution. Use this approach only as a last resort.</p>
+<p>To reiterate: a fresh session is almost always the better, cleaner,
+safer, and more robust solution. Use this approach only as a last
+resort.</p>
</div>
<div id="under-the-hood-rprojroot" class="section level3">
<h3>Under the hood: rprojroot</h3>
-<p>The here package has a very simple and restricted interface, by design. The underlying logic is provided by the much more powerful rprojroot package. If the default behavior of here does not suit your workflow for one reason or another, the rprojroot package may be a better alternative. It is also recommended to import rprojroot and not here from other packages.</p>
-<p>The following example shows how to find an RStudio project starting from a directory:</p>
+<p>The here package has a very simple and restricted interface, by
+design. The underlying logic is provided by the much more powerful
+rprojroot package. If the default behavior of here does not suit your
+workflow for one reason or another, the rprojroot package may be a
+better alternative. It is also recommended to import rprojroot and not
+here from other packages.</p>
+<p>The following example shows how to find an RStudio project starting
+from a directory:</p>
<div class="sourceCode" id="cb22"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb22-1"><a href="#cb22-1" aria-hidden="true" tabindex="-1"></a><span class="fu">library</span>(rprojroot)</span>
<span id="cb22-2"><a href="#cb22-2" aria-hidden="true" tabindex="-1"></a><span class="fu">find_root</span>(is_rstudio_project, <span class="fu">file.path</span>(project_path, <span class="st">"analysis"</span>))</span>
-<span id="cb22-3"><a href="#cb22-3" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project"</span></span></code></pre></div>
-<p>Arbitrary criteria can be defined. See <code>vignette("rprojroot", package = "rprojroot")</code> for an introduction.</p>
+<span id="cb22-3"><a href="#cb22-3" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project"</span></span></code></pre></div>
+<p>Arbitrary criteria can be defined. See
+<code>vignette("rprojroot", package = "rprojroot")</code> for an
+introduction.</p>
</div>
</div>
-<div class="footnotes">
+<div class="footnotes footnotes-end-of-document">
<hr />
<ol>
-<li id="fn1"><p>Prior to version 1.0.0, it was recommended to attach the here package via <code>library(here)</code>. This still works, but is no longer the recommended approach.<a href="#fnref1" class="footnote-back">↩︎</a></p></li>
-<li id="fn2"><p><code>library(here)</code> no longer emits an informative message if <code>here::i_am()</code> has been called before.<a href="#fnref2" class="footnote-back">↩︎</a></p></li>
-<li id="fn3"><p><code>library(here)</code> emits a message that may be confusing if followed by the message from <code>here::i_am()</code>.<a href="#fnref3" class="footnote-back">↩︎</a></p></li>
+<li id="fn1"><p>Prior to version 1.0.0, it was recommended to attach the
+here package via <code>library(here)</code>. This still works, but is no
+longer the recommended approach.<a href="#fnref1" class="footnote-back">↩︎</a></p></li>
+<li id="fn2"><p><code>library(here)</code> no longer emits an
+informative message if <code>here::i_am()</code> has been called
+before.<a href="#fnref2" class="footnote-back">↩︎</a></p></li>
+<li id="fn3"><p><code>library(here)</code> emits a message that may be
+confusing if followed by the message from <code>here::i_am()</code>.<a href="#fnref3" class="footnote-back">↩︎</a></p></li>
</ol>
</div>
diff --git a/inst/doc/rmarkdown.html b/inst/doc/rmarkdown.html
index 0d0cde5..e525c8f 100644
--- a/inst/doc/rmarkdown.html
+++ b/inst/doc/rmarkdown.html
@@ -38,11 +38,20 @@ document.addEventListener('DOMContentLoaded', function(e) {
</style>
-<style type="text/css">code{white-space: pre;}</style>
+
+<style type="text/css">
+ code {
+ white-space: pre;
+ }
+ .sourceCode {
+ overflow: visible;
+ }
+</style>
<style type="text/css" data-origin="pandoc">
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
+.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@@ -77,7 +86,7 @@ code span.al { color: #ff0000; font-weight: bold; } /* Alert */
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code span.at { color: #7d9029; } /* Attribute */
code span.bn { color: #40a070; } /* BaseN */
-code span.bu { } /* BuiltIn */
+code span.bu { color: #008000; } /* BuiltIn */
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code span.ch { color: #4070a0; } /* Char */
code span.cn { color: #880000; } /* Constant */
@@ -90,7 +99,7 @@ code span.er { color: #ff0000; font-weight: bold; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #40a070; } /* Float */
code span.fu { color: #06287e; } /* Function */
-code span.im { } /* Import */
+code span.im { color: #008000; font-weight: bold; } /* Import */
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
code span.op { color: #666666; } /* Operator */
@@ -111,13 +120,20 @@ code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warni
for (var i = 0; i < sheets.length; i++) {
if (sheets[i].ownerNode.dataset["origin"] !== "pandoc") continue;
try { var rules = sheets[i].cssRules; } catch (e) { continue; }
- for (var j = 0; j < rules.length; j++) {
+ var j = 0;
+ while (j < rules.length) {
var rule = rules[j];
// check if there is a div.sourceCode rule
- if (rule.type !== rule.STYLE_RULE || rule.selectorText !== "div.sourceCode") continue;
+ if (rule.type !== rule.STYLE_RULE || rule.selectorText !== "div.sourceCode") {
+ j++;
+ continue;
+ }
var style = rule.style.cssText;
// check if color or background-color is set
- if (rule.style.color === '' && rule.style.backgroundColor === '') continue;
+ if (rule.style.color === '' && rule.style.backgroundColor === '') {
+ j++;
+ continue;
+ }
// replace div.sourceCode by a pre.sourceCode rule
sheets[i].deleteRule(j);
sheets[i].insertRule('pre.sourceCode{' + style + '}', j);
@@ -325,38 +341,60 @@ code > span.er { color: #a61717; background-color: #e3d2d2; }
-<p>The here package enables easy file referencing by using the top-level directory of a file project to easily build file paths. This article demonstrates the case where the working directory is set to a subdirectory of the project root, for instance when rendering an R Markdown document that lives in a subdirectory. See <code>vignette("here")</code> for a more general introduction.</p>
+<p>The here package enables easy file referencing by using the top-level
+directory of a file project to easily build file paths. This article
+demonstrates the case where the working directory is set to a
+subdirectory of the project root, for instance when rendering an R
+Markdown document that lives in a subdirectory. See
+<code>vignette("here")</code> for a more general introduction.</p>
<div id="rmarkdown-starts-in-a-subdirectory" class="section level2">
<h2>rmarkdown starts in a subdirectory</h2>
-<p>For demonstration, this article uses a data analysis project that lives in <code>/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project</code> on my machine. This is the <em>project root</em>. The path will most likely be different on your machine, the here package helps deal with this situation.</p>
+<p>For demonstration, this article uses a data analysis project that
+lives in
+<code>/tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project</code> on my
+machine. This is the <em>project root</em>. The path will most likely be
+different on your machine, the here package helps deal with this
+situation.</p>
<p>The project has the following structure:</p>
-<pre><code>#> /tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project
-#> ├── analysis
-#> │ └── report.Rmd
-#> ├── data
-#> │ └── penguins.csv
-#> ├── demo-project.Rproj
-#> └── prepare
-#> └── penguins.R</code></pre>
-<p>When <code>report.Rmd</code> is rendered, the working directory is internally set to <code><project root>/analysis</code> by rmarkdown:</p>
+<pre><code>#> /tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project
+#> +-- analysis
+#> | \-- report.Rmd
+#> +-- data
+#> | \-- penguins.csv
+#> +-- demo-project.Rproj
+#> \-- prepare
+#> \-- penguins.R</code></pre>
+<p>When <code>report.Rmd</code> is rendered, the working directory is
+internally set to <code><project root>/analysis</code> by
+rmarkdown:</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">setwd</span>(<span class="fu">file.path</span>(project_path, <span class="st">"analysis"</span>))</span></code></pre></div>
<div class="sourceCode" id="cb3"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="fu">getwd</span>()</span>
-<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project/analysis"</span></span></code></pre></div>
-<p>However, <code>penguins.csv</code> still lives in the <code>data/</code> subdirectory. The report requires the <code>penguins.csv</code> file to work.</p>
+<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project/analysis"</span></span></code></pre></div>
+<p>However, <code>penguins.csv</code> still lives in the
+<code>data/</code> subdirectory. The report requires the
+<code>penguins.csv</code> file to work.</p>
</div>
<div id="here-always-uses-project-relative-paths" class="section level2">
<h2>here always uses project-relative paths</h2>
-<p>To render <code>report.Rmd</code>, you would have to ensure the path to <code>penguins.csv</code> is relative to the <code>analysis/</code> directory - i.e., <code>../data/penguins.csv</code>. The chunks would knit properly, but could not be run in the console since the working directory in the console <em>isn’t</em> <code>analysis/</code>.</p>
-<p>The here package circumvents this issue by always referring to the project root:</p>
+<p>To render <code>report.Rmd</code>, you would have to ensure the path
+to <code>penguins.csv</code> is relative to the <code>analysis/</code>
+directory - i.e., <code>../data/penguins.csv</code>. The chunks would
+knit properly, but could not be run in the console since the working
+directory in the console <em>isn’t</em> <code>analysis/</code>.</p>
+<p>The here package circumvents this issue by always referring to the
+project root:</p>
<div class="sourceCode" id="cb4"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a>here<span class="sc">::</span><span class="fu">i_am</span>(<span class="st">"analysis/report.Rmd"</span>)</span>
-<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> here() starts at /tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project</span></span></code></pre></div>
-<p>All files accessed by <code>report.Rmd</code> should be referred to using <code>here()</code>:</p>
+<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="co">#> here() starts at /tmp/Rtmpw5REuS/Rinst6a124297a496/here/demo-project</span></span></code></pre></div>
+<p>All files accessed by <code>report.Rmd</code> should be referred to
+using <code>here()</code>:</p>
<div class="sourceCode" id="cb5"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="fu">library</span>(here)</span>
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a><span class="fu">here</span>(<span class="st">"data"</span>, <span class="st">"penguins.csv"</span>)</span>
-<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project/data/penguins.csv"</span></span>
+<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a><span class="co">#> Error in here("data", "penguins.csv"): unused argument ("penguins.csv")</span></span>
<span id="cb5-4"><a href="#cb5-4" aria-hidden="true" tabindex="-1"></a><span class="fu">here</span>(<span class="st">"data/penguins.csv"</span>)</span>
-<span id="cb5-5"><a href="#cb5-5" aria-hidden="true" tabindex="-1"></a><span class="co">#> [1] "/tmp/RtmpnoXhd8/Rinst301434451937/here/demo-project/data/penguins.csv"</span></span></code></pre></div>
-<p>This ensures that <code>penguins.csv</code> can be read both when the report is knit and when the code is run interactively in the console.</p>
+<span id="cb5-5"><a href="#cb5-5" aria-hidden="true" tabindex="-1"></a><span class="co">#> Error in as.vector(x, "character"): cannot coerce type 'environment' to vector of type 'character'</span></span></code></pre></div>
+<p>This ensures that <code>penguins.csv</code> can be read both when the
+report is knit and when the code is run interactively in the
+console.</p>
</div>
diff --git a/man/i_am.Rd b/man/i_am.Rd
index a1d58ae..52fd1a2 100644
--- a/man/i_am.Rd
+++ b/man/i_am.Rd
@@ -14,7 +14,7 @@ Passing an absolute path raises an error.}
\item{...}{Must be empty, reserved for future use.}
\item{uuid}{\verb{[character(1)]}\cr
-\ifelse{html}{\out{<a href='https://www.tidyverse.org/lifecycle/#experimental'><img src='figures/lifecycle-experimental.svg' alt='Experimental lifecycle'></a>}}{\strong{Experimental}})`
+\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}
If not \code{NULL}, a unique string that is matched
against the first 100 lines of the file.
diff --git a/man/set_here.Rd b/man/set_here.Rd
index d0a22ea..ddfe304 100644
--- a/man/set_here.Rd
+++ b/man/set_here.Rd
@@ -14,7 +14,7 @@ Directory where to create \code{.here} file, defaults to the current directory.}
Verbose output, defaults to \code{TRUE}.}
}
\description{
-\ifelse{html}{\out{<a href='https://www.tidyverse.org/lifecycle/#superseded'><img src='figures/lifecycle-superseded.svg' alt='Superseded lifecycle'></a>}}{\strong{Superseded}}
+\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#superseded}{\figure{lifecycle-superseded.svg}{options: alt='[Superseded]'}}}{\strong{[Superseded]}}
}
\details{
\code{set_here()} creates an empty file named \code{.here}, by default
diff --git a/vignettes/here.Rmd b/vignettes/here.Rmd
index 0164b58..c283a3d 100644
--- a/vignettes/here.Rmd
+++ b/vignettes/here.Rmd
@@ -39,7 +39,7 @@ The project has the following structure:
fs::dir_tree(project_path)
```
-You can review the project on [GitHub](https://github.com/r-lib/here/tree/master/inst/demo-project) and also download a copy.
+You can review the project on [GitHub](https://github.com/r-lib/here/tree/main/inst/demo-project) and also download a copy.
To start working on this project in RStudio, open the `demo-project.Rproj` file.
This ensures that the [working directory](https://en.wikipedia.org/wiki/Working_directory) is set to `` `r project_path` ``, the project root.
Debdiff
File lists identical (after any substitutions)
Control files: lines which differ (wdiff format)
Depends: r-base-core (>= 4.2.2.20221110-2), 4.2.2.20221110-1), r-api-4.0, r-cran-rprojroot (>= 2.0.2)