File: prep_dat.Rd

package info (click to toggle)
r-cran-metadat 1.2-0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 2,108 kB
  • sloc: sh: 13; makefile: 2
file content (20 lines) | stat: -rw-r--r-- 942 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
\name{prep_dat}
\alias{prep_dat}
\title{Data preparation function}
\description{Function to run data processing scripts.}
\usage{
prep_dat(rebuild=FALSE, overwrite, pkgdir)
}
\arguments{
   \item{rebuild}{logical indicating whether the entire database should be rebuild (default is \code{FALSE}).}
   \item{overwrite}{character vector with one or more \code{.Rd} filenames to overwrite (if they already exist). The default is to never overwrite any existing \code{.Rd} files.}
   \item{pkgdir}{character string specifying the root directory of the source package (if unspecified, the current working directory is assumed to be the package root directory).}
}
\details{
   The function is only for used for processing new datasets for inclusion in the package. It should be used as described on the \pkg{\link{metadat-package}} help page.
}
\author{
   Wolfgang Viechtbauer, \email{wvb@metafor-project.org}
}
\keyword{file}
\keyword{internal}