Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

swh:1:snp:a4c99a50dc49f82b591f268001b320f8c3ca0041
  • Code
  • Branches (42)
  • Releases (0)
    • Branches
    • Releases
    • HEAD
    • refs/heads/master
    • refs/tags/0.96
    • refs/tags/0.97-1
    • refs/tags/1.0-1
    • refs/tags/1.0-2
    • refs/tags/1.0-3
    • refs/tags/1.0-4
    • refs/tags/1.0-5
    • refs/tags/1.0-6
    • refs/tags/1.0-6.1
    • refs/tags/R-2.10.0
    • refs/tags/R-2.10.1
    • refs/tags/R-2.11.0
    • refs/tags/R-2.11.1
    • refs/tags/R-2.12.0
    • refs/tags/R-2.12.1
    • refs/tags/R-2.12.2
    • refs/tags/R-2.13.0
    • refs/tags/R-2.13.1
    • refs/tags/R-2.13.2
    • refs/tags/R-2.14.0
    • refs/tags/R-2.14.1
    • refs/tags/R-2.14.2
    • refs/tags/R-2.15.0
    • refs/tags/R-2.15.1
    • refs/tags/R-2.15.2
    • refs/tags/R-2.15.3
    • refs/tags/R-2.6.0
    • refs/tags/R-2.6.1
    • refs/tags/R-2.6.2
    • refs/tags/R-2.7.0
    • refs/tags/R-2.7.1
    • refs/tags/R-2.7.2
    • refs/tags/R-2.8.0
    • refs/tags/R-2.8.1
    • refs/tags/R-2.9.0
    • refs/tags/R-2.9.1
    • refs/tags/R-2.9.2
    • refs/tags/R-3.0.0
    • refs/tags/R-3.0.1
    • refs/tags/R-3.0.2
    • refs/tags/R-3.0.3
    No releases to show
  • 46ec0e1
  • /
  • man
  • /
  • exampleFiles.Rd
Raw File Download
Permalinks

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
  • revision
  • snapshot
content badge Iframe embedding
swh:1:cnt:b81f274794e4d797ae13f6699a1efebf77e70c5d
directory badge Iframe embedding
swh:1:dir:b8e8ff44b5e9724f390de5aae681dc35a28d4b65
revision badge
swh:1:rev:635622b024294f87a1442a50ad662642f5586aa7
snapshot badge
swh:1:snp:a4c99a50dc49f82b591f268001b320f8c3ca0041
Citations

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
  • revision
  • snapshot
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Tip revision: 635622b024294f87a1442a50ad662642f5586aa7 authored by jmc on 14 July 2008, 00:00:00 UTC
version 1.0-4
Tip revision: 635622b
exampleFiles.Rd
\name{exampleFiles}
\alias{exampleFiles}
\alias{examplePages}
\title{ Path to Files in the Examples Subdirectory }
\description{
  Given one or more file names, returns the corresponding paths to files in the \code{"Examples"} subdirectory of a package.  With the \code{names} argument missing, returns the names of all such files.
}
\usage{
exampleFiles(names = character(), where = "SoDA", oneFile = FALSE, path = TRUE)
}
\arguments{
  \item{names}{Either character string names or page numbers matched
      against the file names defined by the second argument.  See
      details below.}
  \item{where}{The name of the package containing the
      \code{"Examples"} directory, by default, this package, or else
      the path name of a directory which itself contains the files of interest. }
  \item{oneFile}{ If \code{TRUE}, and more than one file matches, the
      caller will be asked to select one of these files. }
  \item{path}{  If \code{TRUE}, the file(s) will be returned with full
    directory paths; else, only with the file names.}
}
\details{
  In any call, argument \code{names} can be a vector of character
  string names, expected to match files in the directory of examples.
  The names may match only the leading part of the file name; in
  particular, it will often be the case that the actual file name has
  a suffix such as \code{".R"}, omitted in the \code{names} argument.

  If the argument \code{where} is a package name, then that
  package is expected to have a directory named \code{"Examples"}, as
  does this package.  In all other circumstances, this argument must
  itself be the path name of a directory containing the example files.

  In the case of a package, if the package has a data frame object
  named \code{examplePages}, that object will be used to match page
  numbers of a document on which the examples appear.  In the default
  case, the document is the book \emph{Software for Data Analysis}.
  If you see an example in the book that appears to be the output from
  running some \R code, enter the page number on which the output
  starts as the \code{names} argument.  Often (though not always) the
  corresponding \R code is one of the files in the \code{Examples}
  directory of the package.  Some other files, such as source in other
  languages or related data, are also provided
  corresponding to examples.

  Note that the same use of page numbers applies in calls to
  \code{\link{runExample}} or \code{\link{demoExample}}.
}
\value{
  Names for the matching files, or for all such files if \code{names} was missing.
}
\seealso{  \code{\link{runExample}} to run such files, and
  \code{\link{demoExample}} to run them as interactive demos. }
\keyword{programming}


back to top

Software Heritage — Copyright (C) 2015–2025, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Contact— JavaScript license information— Web API