search for: inlinedoc

Displaying 16 results from an estimated 16 matches for "inlinedoc".

Did you mean: inlinedocs
2013 Jan 24
2
functions as arguments to ther functions with inlinedocs
Dear R community, I have a problem when I use functions as default values for argumnents in other functions. When I use curly brackets { here, I can not create a package with inlinedocs. It will give me the error when using package.skeleton() in my package structure: Error in parse(text = utxt) : <text>:4:0: unexpected end of input For example: dummyfunction = function(filters = function(x) {b = 0; x > b} )) { # rest of code here return(filters) } This seems...
2011 Sep 08
1
invalid strings while parsing code with inlinedocs package.skeleton.dx()
Dear list members, I use the package inlinedocs to create documentation for a package that I am building. The function package.skeleton.dx() is used to convert the source *.R file into the *.Rd documentation file. Usually this works like a charm, but on several occasions I got messages like this one: extra.code.docs prefixed.lines extract...
2014 Jan 07
1
Why do methods of "initialize" have no "srcref" attribute as other S4 mehtods?
For documentation we use a system that generates Rd files from special comments in the code. (inlinedocs). It is crucial to be able to get the defining source code for objects like methods to extract the comments from it. Here is an R session that shows how this works for several kinds of methods and (at the end of the session) how if fails for methods of "initialize" > require("m...
2011 Jul 06
1
including figures in html documentation/help
...lude figures to the html help pages of individueal functions (containing for example a plot produced by that function?) I thought about adding these figures into a 'graphs' subfolder of the package folder and then to somehow insert some sort of html link into the documentation code. I use inlinedocs for creating the documentation. Any ideas? Jannis
2010 Aug 17
1
prompt () and backticks for default arguments
...ields: \usage{ f(FUN = *) } %- maybe also 'usage' for other objects documented here. without the backticks, which is of course found by R CMD check as syntax error. While this is easily fixed if the .Rd is further edited manually, I stumbled over it using the automated .Rd generation with inlinedocs - in this combination it is very inconvenient. Any suggestions? All the best, Claudia -- Claudia Beleites Dipartimento dei Materiali e delle Risorse Naturali Universit? degli Studi di Trieste Via Alfonso Valerio 6/a I-34127 Trieste phone: +39 0 40 5 58-37 68 email: cbeleites at units.it
2018 Jan 30
0
Best practices in developing package: From a single file
...d > >> documentation. Do you know a way to generate documentation and a > >> package out of single R source file, or from an environment? I think you want to see the approach to generating a skeleton from a single .R file presented in: Simple and sustainable R packaging using inlinedocs http://inlinedocs.r-forge.r-project.org/ I have not used it in some time but found it invaluable when I did. I would be VERY INTERESTED to hear how others feel it has held up. Joining conversation late, ~malcolm_cook at stowers.org > > > > Mehmet, > > > > This list...
2010 Aug 29
3
a small suggestion for improving the building of packages
All, I just finished the process of build a package for the first time and found it characteristically (for R) very straightforward and well documented. Whenever I deal with open source software I always endeavor to finish the task I have in mind, and upon completing this, I then revisit all of the configurations, customizing as necessary to achieve my goals more fully. The ability to achieve
2012 May 17
2
test suites for packages
Can anyone share some opinions on test suites for R packages? I'm looking at testthat and RUnit. Does anyone have strong opinions on either of those. Any additional packages I should consider? Thanks, Whit
2018 Jan 30
7
Best practices in developing package: From a single file
On 30/01/2018 11:29 AM, Brian G. Peterson wrote: > On Tue, 2018-01-30 at 17:00 +0100, Suzen, Mehmet wrote: >> Dear R developers, >> >> I am wondering what are the best practices for developing an R >> package. I am aware of Hadley Wickham's best practice >> documentation/book (http://r-pkgs.had.co.nz/).??I recall a couple of >> years ago there were some
2009 Oct 01
1
Looking for a better way to document my packages
Hi all, Trying to do what my subject says. As I'm trying to be better about making packages out of my code, I'd like the packages themselves to be better, which means *.Rd- documenting my code. The thing is, from years of programming other languages prior to landing in the R pond, I've grown accustomed to documenting my functions inline. I'm not just used to it, but I like
2018 Jan 30
3
Best practices in developing package: From a single file
Dear R developers, I am wondering what are the best practices for developing an R package. I am aware of Hadley Wickham's best practice documentation/book (http://r-pkgs.had.co.nz/). I recall a couple of years ago there were some tools for generating a package out of a single file, such as using package.skeleton, but no auto-generated documentation. Do you know a way to generate
2009 Aug 24
6
CRAN (and crantastic) updates this week
CRAN (and crantastic) updates this week New packages ------------ Updated packages ---------------- New reviews ----------- This email provided as a service for the R community by http://crantastic.org. Like it? Hate it? Please let us know: cranatic at gmail.com.
2010 Aug 25
1
Documenting S4 Methods
I'm in the process of converting some S3 methods to S4 methods. I have this function : setGeneric("enrichmentCalc", function(rs, organism, seqLen, ...){standardGeneric("enrichmentCalc")}) setMethod("enrichmentCalc", c("GenomeDataList", "BSgenome"), function(rs, organism, seqLen, ...) { ... ... ... })
2011 Aug 23
5
Easier ways to create .Rd files?
R-helpers: Are there any ways to auto-generate R-friendly (e.g. will pass a compilation check) .Rd files given a set of .R code? How about GUIs that help properly format the .Rd files? Thanks! I want a basic set of .Rd files that I can update as I go, but as with most things my documentation typically lags behind my coding by a few days. --j -- Jonathan A. Greenberg, PhD Assistant Project
2012 May 20
1
CRAN (and crantastic) updates this week
CRAN (and crantastic) updates this week New packages ------------ * bisectr (0.0.2) Maintainer: Winston Chang Author(s): Winston Chang <winston at stdout.org> License: GPL-2 http://crantastic.org/packages/bisectr Tools to find bad commits with git bisect * CUMP (1.0) Maintainer: Xuan Liu Author(s): Xuan Liu <liuxuan at bu.edu> and Qiong Yang <qyang at bu.edu>
2010 Jul 18
6
CRAN (and crantastic) updates this week
...idgetsrJava (0.0-19), gWidgetstcltk (0.0-38), gWidgetsWWW (0.0-19), hapassoc (1.2-4), hash (2.0.1), hergm (1.2-5), hglm (1.1.1), highlight (0.2-1), Hmisc (3.8-2), hopach (2.9.1), ibr (1.2.2), identity (0.2-1), ifultools (1.0-7), imprProbEst (1.0.1), impute (1.22.0), imputeMDR (1.1), inline (0.3.5), inlinedocs (1.1), intamapInteractive (1.0-9), intervals (0.13.2), introgress (1.2.3), ipw (1.0-5), isa2 (0.2.1), ismev (1.35), isopam (0.9-8), kernlab (0.9-10), kmi (0.3-3), kml (1.1.2), ks (1.6.13), kza (1.03.1), languageR (1.0), lasso2 (1.2-11), latentnet (2.3-0), lattice (0.18-8), latticedl (1.1), lattice...