Document how to think about Rproj files and related workflows in Positron #34
Conversation
✅ Deploy Preview for positron-posit-co ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
@DavisVaughan @gadenbuie @hadley and any other interested parties. Here's a rough start on some docs around coping with the lack of an |
|
Also paging @jthomasmock |
There was a problem hiding this comment.
I think this is great! I've focused on the big stuff (although I could make small copy-edit suggestions too if you'd like).
The content and flow are great. When you're ready, a few choice images will make a big impact, both to reinforce the text and to visually break up the text.
(Side note: I prefer your original wording for all of the places flagged by the vale contractions rules.)
|
Thanks @gadenbuie that's exactly the kind of feedback I am looking for. Yeah I think I started strong with a vision and it slowly morphed into just logging information I know we need to share as my enthusiasm waned. |
jennybc
force-pushed
the
project-manager-and-raycast
branch
from
e851bfc to
277089f
Compare
Co-authored-by: Davis Vaughan <[email protected]>
|
OK interested people, I consider this PR ready to go. |
| * R package: Presence of a `DESCRIPTION` file. | ||
| * renv project: Presence of an `renv.lock` file. | ||
| * Quarto project: Presence of a `_quarto.yml` file. | ||
|
|
There was a problem hiding this comment.
Is it worth including .here empty file? I worry that folks might miss the one-off sentence about .here later on. Also see comment above re "advertises" sentence.
|
|
||
| ## Explicit project-hood | ||
|
|
||
| Most data science project folders advertise their project-hood in one or more ways, such as: |
There was a problem hiding this comment.
Maybe reframe as "advertise their project-hood and/or project root in..." to let us include .here?
There was a problem hiding this comment.
My feeling about this, which also encompasses your next comment, is that I'm trying to walk this line: I really want this article to be mostly about project launching.
But I couldn't pass up the chance to give a second concrete example of a gesture that absolutely relies on the notion of a project. I also want to combat some FUD out there around Positron not playing nicely with here.
So I'm pretty satisfied with the current coverage (or lack thereof) of here and .here.
There was a problem hiding this comment.
I can live with that 🫡
Co-authored-by: Garrick Aden-Buie <[email protected]>
Co-authored-by: Garrick Aden-Buie <[email protected]>
| In RStudio, you can designate the folder for a particular project (lowercase "p") as an [RStudio Project](https://docs.posit.co/ide/user/ide/guide/code/projects.html) (uppercase "P"). | ||
| Concretely, this means that RStudio places a special file in that folder, where it stores Project-specific settings. | ||
| This file is usually named after the Project and has the `.Rproj` extension, so we're going to refer to them as Rproj files here. | ||
| For example, the source of the dplyr R package is kept in a folder named `dplyr` and, inside of that, is the `dplyr.Rproj` file. |
There was a problem hiding this comment.
IMO this feels like a natural place to say: "That's not the case for Positron"
There was a problem hiding this comment.
I've done some rewording/rearranging.
rstudio-rproj-file.qmd
Outdated
| Then a hotkey can be associated with the intention "hey, I want to launch an RStudio Project" and, after typing just enough characters to disambiguate the target, a new RStudio is instance is launched. | ||
|
|
||
| So, the Rproj file has become load-bearing and plays a key role in some workflows that go beyond its original purpose of storing metadata for the RStudio IDE. | ||
| This begs the question: what is the equivalent of the Rproj file in Positron? |
There was a problem hiding this comment.
I think you take a little bit too long to get to this point — something alluding to this needs to go in the very first paragraph.
There was a problem hiding this comment.
I've done some rewording/rearranging.
|
|
||
| Most data science project folders advertise their project-hood in one or more ways, such as: | ||
|
|
||
| * RStudio Project: Presence of an Rproj file. |
There was a problem hiding this comment.
I like this summary. Is it worth also mentioning .here here?
There was a problem hiding this comment.
@jthomasmock and I discussed this above: #34 (comment)
I don't really want to mention .here at that point because this really isn't about here/rprojroot, I don't think many people use .here, and .here doesn't solve the project launch problem. I do mention it a bit further down.
| <!-- vale Posit.Headings = YES --> | ||
|
|
||
| <!-- vale Posit.Contractions = NO --> | ||
| The concept in Positron that's most analogous to an RStudio Project is a **workspace** and this is inherited directly (and intentionally) from VS Code. |
There was a problem hiding this comment.
The folder drop down menu at the top-right talks about projects, not workspaces.
And in general, I'm confused by the difference between projects and workspaces in Positron. Are they two words for the same thing?
There was a problem hiding this comment.
I'm about to push some changes that touch on this and hopefully reduce confusion within the context of this guide.
But we also have an issue open about tackling the confusion more generally: posit-dev/positron#4787
This topic has been in our sights re: helping folks map their RStudio mindset and workflows onto Positron and it's on our list of the top irritating things to fix/address before release.
I've initiated a new section for guides where we can gradually add more articles re: migration.
Existing mega-issue on migration topics we'd like to address:
posit-dev/positron#4157