File: find_devpackage.Rd

package info (click to toggle)
r-cran-pkgmaker 0.27-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,152 kB
  • sloc: sh: 13; makefile: 2
file content (30 lines) | stat: -rw-r--r-- 1,033 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/project.R
\name{find_devpackage}
\alias{find_devpackage}
\title{Find Path to Development Package Root Directory}
\usage{
find_devpackage(x, error = TRUE)
}
\arguments{
\item{x}{name of the development package to lookup.}

\item{error}{logical that indicates if an error is thrown when the project root directory
could not be found.}
}
\description{
Development packages are looked-up according to rules
defined in a file \code{.Rpackages} in the user's home directory.
}
\section{Specification of package path}{

Package paths are specified in a list with:
\itemize{
\item unnamed elements: character strings give path to directories to lookup for sub-directories that match
exactly the package's name;
\item named element containing character strings: these are paths that are looked up only for packages that
match the element name. If the element name contains any of the characters \code{*?()$^\\][}, then it is matched using
regular expression.
}
}