File: getParent.Rd

package info (click to toggle)
r-cran-r.utils 2.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 2,936 kB
  • sloc: sh: 18; makefile: 6
file content (44 lines) | stat: -rwxr-xr-x 1,178 bytes parent folder | download | duplicates (5)
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
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  getParent.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{getParent}
\alias{getParent.default}
\alias{getParent}

\title{Gets the string of the parent specified by this pathname}

\description{
 Gets the string of the parent specified by this pathname.
 This is basically, by default the string before the last path separator
 of the absolute pathname.
}

\usage{
\method{getParent}{default}(pathname, depth=1L, fsep=.Platform$file.sep, ...)
}

\arguments{
  \item{pathname}{A \code{\link[base]{character}} string of the pathname to be checked.}
  \item{depth}{An \code{\link[base]{integer}} specifying how many generations up the
     path should go.}
  \item{fsep}{A \code{\link[base]{character}} string of the file separator.}
  \item{...}{Not used.}
}

\value{
 Returns a \code{\link[base]{character}} string if the parent exists, otherwise \code{\link[base]{NULL}}.
}



\author{Henrik Bengtsson}



\keyword{IO}
\keyword{programming}