Add function to report the State of the Project and Working Directory

[jennybc]

Objective: create a reporter or doctor function that reveals

• working directory
• active usethis project
• active RStudio project

The print() method goes on to make observations about the state of things and to suggest ways to get back to the ideal situation: working directory == active usethis project == active RStudio project.

Intended for use in remote debugging / reprexing, live workshops, writing, when people get into weird situations due to awkward workflow (or a usethis bug).

Questions I have:

• Overall 👍 or 👎?
• Is this a good name? Recall, there are vague plans to add some other reporter/doctor functions.
• Should I only offer advice on what to do or should there be functions to facilitate?
  • For example, setwd(rstudioapi::getActiveProject()) might deserve nicer packaging. This is equivalent to IDE workflows: Session > Set Working Directory > To Project Directory or Files pane > click on RStudio icon to focus file browser on Project > More ... > Set As Working Directory.

[jennybc]

Situation normal (no RStudio, because reprex/callr):

library(usethis)

proj_sitrep()
#>       working_directory:     '/Users/jenny/rrr/usethis'
#>     active_usethis_proj:     NULL
#>     active_rstudio_proj:     NULL
#> 
#> ● There is currently no active usethis project.
#>   usethis attempts to activate a project upon first need.
#>   Call `proj_get()` to explicitly initiate project activation.

proj_get()
#> ✔ Setting active project to '/Users/jenny/rrr/usethis'
#> /Users/jenny/rrr/usethis

proj_sitrep()
#>       working_directory:     '/Users/jenny/rrr/usethis'
#>     active_usethis_proj:     '/Users/jenny/rrr/usethis'
#>     active_rstudio_proj:     NULL

Created on 2018-08-05 by the reprex package (v0.2.0.9000).

---

What this looks like in RStudio

library(usethis)

proj_sitrep()
#>       working_directory:     '/Users/jenny/rrr/usethis'
#>     active_usethis_proj:     NULL
#>     active_rstudio_proj:     '/Users/jenny/rrr/usethis'
#> 
#> ● There is currently no active usethis project.
#>   usethis attempts to activate a project upon first need.
#>   Call `proj_get()` to explicitly initiate project activation.

proj_get()
#> ✔ Setting active project to '/Users/jenny/rrr/usethis'
#> /Users/jenny/rrr/usethis

proj_sitrep()
#>       working_directory:     '/Users/jenny/rrr/usethis'
#>     active_usethis_proj:     '/Users/jenny/rrr/usethis'
#>     active_rstudio_proj:     '/Users/jenny/rrr/usethis'

---

Creating a much more disordered state, in RStudio:

> devtools::load_all("~/rrr/usethis")
Loading usethis
✔ Setting active project to '/Users/jenny/rrr/usethis'

> ## set working to directory to NOT this RStudio Project
> setwd("~")

> ## set usethis project to something below tempdir
> usethis:::scoped_temporary_project()
✔ Switching to a temporary project!
● Restore current project with: `proj_set("/Users/jenny/rrr/usethis")`

> proj_sitrep()
      working_directory:     '/Users/jenny'
    active_usethis_proj:     '/private/var/folders/vr/gzrbtprx6ybg85y5pvwm1ct40000gn/T/Rtmp88agSz/aaa335b7f4aee01'
    active_rstudio_proj:     '/Users/jenny/rrr/usethis'

● Your working directory is not the same as the active usethis project.
  To set working directory to the project: `setwd(proj_get())`
  To activate project in working directory: `proj_set(getwd())`
● Your working directory is not the same as the active RStudio Project.
  To set working directory to the Project: `setwd(rstudioapi::getActiveProject())`
● Your active RStudio Project is not the same as the active usethis project.
  To set usethis project to RStudio Project: `proj_set(rstudioapi::getActiveProject())`

[hadley]

Call this function if something seems wacky but you don't know what.

[hadley]

I think this could just be format(names(x))

[hadley]

You can drop the else NULL; that's the default value of the else block.