File: packages.Rd

package info (click to toggle)
r-cran-pkgload 1.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,164 kB
  • sloc: sh: 13; cpp: 9; ansic: 8; makefile: 2
file content (46 lines) | stat: -rw-r--r-- 1,090 bytes parent folder | download | duplicates (2)
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
35
36
37
38
39
40
41
42
43
44
45
46
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/package.R
\name{packages}
\alias{packages}
\alias{pkg_path}
\alias{pkg_name}
\alias{pkg_desc}
\alias{pkg_version}
\alias{pkg_version_raw}
\alias{pkg_ns}
\title{Helper functions for working with development packages.}
\usage{
pkg_path(path = ".")

pkg_name(path = ".")

pkg_desc(path = ".")

pkg_version(path = ".")

pkg_version_raw(path = ".")

pkg_ns(path = ".")
}
\arguments{
\item{path}{Path to a package, or within a package.}
}
\description{
All functions search recursively up the directory tree from the input path
until they find a DESCRIPTION file.
}
\section{Functions}{
\itemize{
\item \code{pkg_path()}: Return the normalized package path.

\item \code{pkg_name()}: Return the package name.

\item \code{pkg_desc()}: Return the package DESCRIPTION as a \code{\link[desc:desc]{desc::desc()}} object.

\item \code{pkg_version()}: Return the parsed package version.

\item \code{pkg_version_raw()}: Return the raw package version (as a string).

\item \code{pkg_ns()}: Return the package namespace.

}}