On 08/09/2016 10:15 AM, Michael Friendly wrote:
devtools::document() is meant to be used within an R **package**, not
for a standalone file.
Try devtools::create() first.
But at any rate, roxygen format seems to answer your question about
how to describe the
specifications for a collection of
devtools::document() is meant to be used within an R **package**, not
for a standalone file.
Try devtools::create() first.
But at any rate, roxygen format seems to answer your question about how
to describe the
specifications for a collection of functions written by different
people. Translati
I'm trying the example on Hadley's page. I save the following into a file
called "test.R"
#' Add together two numbers.
#'
#' @param x A number.
#' @param y A number.
#' @return The sum of \code{x} and \code{y}.
#' @examples
#' add(1, 1)
#' add(10, 1)
add <- function(x, y) {
x + y
}
Then from
You might also or instead look at the roxygen way of doing things, which
maps to Rd files, but are much easier to write. In R Studio,
Code -> Insert Roxygen skeleton does this for you from an existing
function. See: http://r-pkgs.had.co.nz/man.html
#' title goes here
#'
#' description goes he
r-help@r-project.org
Subject: Re: [R] R-specific Software Requirement Specification
On 07/09/2016 11:35 AM, Doran, Harold wrote:
> I'm building a large program with many different people contributing to the
> coding in R and so it needs a well-articulated design spec. The program will
On 07/09/2016 11:35 AM, Doran, Harold wrote:
I'm building a large program with many different people contributing to the
coding in R and so it needs a well-articulated design spec. The program will
have many different functions that must interact with each other, but the
individual functions w
Yes! ...
and you might consider writing your specifications along with example
R code using rmarkdown. The Rstudio GUI has a nice interface and
support tools (e.g. for compiling and previewing the doc) for writing
rmarkdown, but you can also load and use the package through whatever
R interface yo
I use Mercurial for this.
-Original Message-
From: R-help [mailto:r-help-boun...@r-project.org] On Behalf Of Rich Shepard
Sent: Wednesday, September 07, 2016 11:56 AM
To: r-help@r-project.org
Subject: Re: [R] R-specific Software Requirement Specification
On Wed, 7 Sep 2016, Doran
On Wed, 7 Sep 2016, Doran, Harold wrote:
I'm building a large program with many different people contributing to
the coding in R and so it needs a well-articulated design spec. The
program will have many different functions that must interact with each
other, but the individual functions will be
I'm building a large program with many different people contributing to the
coding in R and so it needs a well-articulated design spec. The program will
have many different functions that must interact with each other, but the
individual functions will be written by different people.
I'm curiou
10 matches
Mail list logo
