File: use_directory.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 (23 lines) | stat: -rw-r--r-- 697 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/directory.R
\name{use_directory}
\alias{use_directory}
\title{Use a directory}
\usage{
use_directory(path, ignore = FALSE)
}
\arguments{
\item{path}{Path of the directory to create, relative to the project.}

\item{ignore}{Should the newly created file be added to \code{.Rbuildignore}?}
}
\description{
\code{use_directory()} creates a directory (if it does not already exist) in the
project's top-level directory. This function powers many of the other \code{use_}
functions such as \code{\link[=use_data]{use_data()}} and \code{\link[=use_vignette]{use_vignette()}}.
}
\examples{
\dontrun{
use_directory("inst")
}
}