File: proj_sitrep.Rd

package info (click to toggle)
r-cran-usethis 3.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,228 kB
  • sloc: sh: 26; makefile: 17; cpp: 6; ansic: 3
file content (34 lines) | stat: -rw-r--r-- 890 bytes parent folder | download | duplicates (3)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/sitrep.R
\name{proj_sitrep}
\alias{proj_sitrep}
\title{Report working directory and usethis/RStudio project}
\usage{
proj_sitrep()
}
\value{
A named list, with S3 class \code{sitrep} (for printing purposes),
reporting current working directory, active usethis project, and active
RStudio Project
}
\description{
\code{proj_sitrep()} reports
\itemize{
\item current working directory
\item the active usethis project
\item the active RStudio Project
}

Call this function if things seem weird and you're not sure
what's wrong or how to fix it. Usually, all three of these should coincide
(or be unset) and \code{proj_sitrep()} provides suggested commands for getting
back to this happy state.
}
\examples{
proj_sitrep()
}
\seealso{
Other project functions: 
\code{\link{proj_utils}}
}
\concept{project functions}