Gets the path to the accompanying documentation (doc/) directory of this package

Description

Gets the path to the accompanying documentation (doc/) directory of this package.

Usage

## S3 method for class 'Package'
getDocPath(this, ...)

Arguments

Value

Returns a character string.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.

Examples

  print(list.files(getDocPath(R.oo)))   # explicit call, or
  print(list.files(R.oo$docPath))       # as a virtual field

Results

R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(R.oo)
Loading required package: R.methodsS3
R.methodsS3 v1.7.1 (2016-02-15) successfully loaded. See ?R.methodsS3 for help.
R.oo v1.20.0 (2016-02-17) successfully loaded. See ?R.oo for help.

Attaching package: 'R.oo'

The following objects are masked from 'package:methods':

    getClasses, getMethods

The following objects are masked from 'package:base':

    attach, detach, gc, load, save

> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/R.oo/getDocPath.Package.Rd_%03d_medium.png", width=480, height=480)
> ### Name: getDocPath.Package
> ### Title: Gets the path to the accompanying documentation (doc/) directory
> ###   of this package
> ### Aliases: getDocPath.Package Package.getDocPath
> ###   getDocPath,Package-method
> ### Keywords: internal methods
> 
> ### ** Examples
> 
>   print(list.files(getDocPath(R.oo)))   # explicit call, or
[1] "Bengtsson.pdf"
>   print(list.files(R.oo$docPath))       # as a virtual field
[1] "Bengtsson.pdf"
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>