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
  • /
  • packageAdd.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:132d65cef5443872eec95906c29fa6bd72bbc3b0
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
packageAdd.Rd
\name{packageAdd}
\alias{packageAdd}
\title{ Add contents of R source files to a source package}
\description{
  The contents of one or more files of R  source code will be added to the specified source package: the files themselves will be added to the \code{R} directory, and shells for the  documentation will be added to the \code{man} directory.  Unlike \code{\link{package.skeleton}}, this function does not require one function per source file and supports both class and method definitions.
}
\usage{
packageAdd(pkg, files, path = ".", document = TRUE)
}
\arguments{
  \item{pkg}{ The name of the package.  It must be attached to the session. }
  \item{files}{ The names of the files containing the R source to add to the package. }
  \item{path}{ The directory under which the source for \code{pkg} is stored. }
  \item{document}{ Should a skeleton documentation for the objects be generated? }
}
\details{
  The file of source code is copied unchanged to the  \code{"R"} subdirectory of the source package.  A shell of documentation is initialized for all the objects created by the evaluating the file.

If the file generates several function objects, the documentation shells for all of these, as generated by the \code{\link{prompt}()} function, are merged and stored under the name of the file, suffix \code{".Rd"}, in the \code{"man"} subdirectory of the package.

Currently method and class documentation are generated on separate files rather than being merged with function documentation.
}
\value{
Nothing useful.  Called for its side effects.
 }
\seealso{  \code{\link{promptAll}}}
\examples{
\dontrun{
packageAdd("SoDA", "triDiagonal.R", "~/RPackage")
}
}
\keyword{ documentation }
\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