File: runExample.Rd

package info (click to toggle)
r-cran-tmb 1.9.17-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,344 kB
  • sloc: cpp: 52,049; ansic: 382; makefile: 11
file content (37 lines) | stat: -rw-r--r-- 814 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/examples.R
\name{runExample}
\alias{runExample}
\title{Run one of the test examples.}
\usage{
runExample(
  name = NULL,
  all = FALSE,
  thisR = TRUE,
  clean = FALSE,
  exfolder = NULL,
  dontrun = FALSE,
  subarch = TRUE,
  ...
)
}
\arguments{
\item{name}{Character name of example.}

\item{all}{Run all the test examples?}

\item{thisR}{Run inside this R?}

\item{clean}{Cleanup before compile?}

\item{exfolder}{Alternative folder with examples.}

\item{dontrun}{Build only (don't run) and remove temporary object files ?}

\item{subarch}{Build in sub-architecture specific folder ?}

\item{...}{Passed to \code{\link{compile}}.}
}
\description{
Compile and run a test example (\code{runExample()} shows all available examples).
}