File: argparser-package.Rd

package info (click to toggle)
r-cran-argparser 0.7.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 252 kB
  • sloc: sh: 13; makefile: 2
file content (30 lines) | stat: -rw-r--r-- 924 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/argparser-package.R
\docType{package}
\name{argparser-package}
\alias{argparser}
\alias{argparser-package}
\title{Command-line argument parser}
\description{
\code{argparser} provides functions for parsing command-line arguments.
}
\details{
To use the parser,
\enumerate{
\item create an \code{arg.parser} object with \code{\link{arg_parser}};
\item add arguments to the parser with \code{\link{add_argument}};
\item call \code{\link{parse_args}} to parse the command line arguments.
}
To execute the script, invoke \code{Rscript}.
Alternatively on Linux, insert a shebang on the first line
(\code{#!/usr/bin/env Rscript}) and \code{chmod +x} the script,
}
\seealso{
Useful links:
\itemize{
  \item \url{https://bitbucket.org/djhshih/argparser}
  \item Report bugs at \url{https://bitbucket.org/djhshih/argparser/issues}
}

}
\keyword{internal}