r - roxygen2 + cygwin + default parameter = truncated `\usage` section -

-

i have package r i've been developing under linux, , horrible time has come i'm testing under windows.

the documentation done using roxygen, , using cygwin build package.

the thing is, when roxygenise('test-package'), roxygen truncates \usage section of documentation 1 character. not of functions, , can't figure out pattern.

this not occur when run same command (i.e. roxygenise('test-package') r prompt) under linux or windows - cygwin under windows (using r devtools + command prompt windows isn't option me - it's part of big project makefiles etc).

in cases, using roxygen v2.2.2.

update:

this appears occur function default parameter.

i've boiled down 1 reproducible example, trimmed down as possible isolate problem:

  1. from r:

    # function used trim strings, i've stripped right down # eliminate cause of problem trim <- function(x='asdf') {     return( x ) } package.skeleton('test')

  2. modify trim.r (in test/r) , add following roxygen top, file looks like:

    #' trim white spaces string #' #' @param x string or vector of strings trim #' @return x trimmed. #' @export trim <- function(x='asdf') {     return( x ) }

  3. run r , generate documentation:

    library(roxygen2) roxygenise('test')

  4. look @ resulting trim.rd file (in test/man):

    \name{trim} \alias{trim} \title{trim white spaces string} \usage{   t } \arguments{   ... # rest of .rd file - nothing wrong here.

see how there's \usage{t} ??

of course, when 1 runs r cmd check 1 gets error documented arguments not appearing in \usage, that's because \usage got truncated.

does know why occurs , how can work around it? perhaps in roxygen2 relies on works in mac, windows & linux not cygwin?

cheers (i've been tearing hair out on this).

update #2:

i have been using r installed cygwin's package manager, opposed windows r (ie 1 in c:/program files/r/r-2.14.2/bin) - didn't realise windows r work under cygwin.

if use windows r in cygwin, bug goes away. if use cygwin r in cygwin, bug present.

i can assume bug related cygwin r, opposed roxygen2.

for use workaround of using windows r within cygwin (in fact, know can this, there's no need cygwin r anyway!).

this not fix, workaround.

i have been using r installed cygwin's package manager, opposed windows r (ie 1 in c:/program files/r/r-2.14.2/bin) - didn't realise windows r work under cygwin.

if use windows r in cygwin, bug goes away. if use cygwin r in cygwin, bug present.

i can assume bug related cygwin r, opposed roxygen2.

for use workaround of using windows r within cygwin (in fact, know can this, there's no need cygwin r anyway). still gives me access linux commands make, sed , grep, allows me documentation working.

the problem still remains cygwin-r in cygwin (not windows-r in cygwin) causes bug, perhaps not related roxygen2 more.


Comments

Post a Comment

Popular posts from this blog

delphi - How to convert bitmaps to video? -

-
Image
my application creates images fractals , love feeling of 'flying' around fractal. once saved 2000 bitmaps file , created avi using premiere. experience rather frustrating though succeeded in creating movie. spectacular. of course want create video application. don't care niftyness of codec, compression or whatever. want have video can replay on systems. in past have tried never succeeded. triggered question alas not ffmpeg running. update i decided adapt question , put bounty it. have seen several solutions attractive (because it's simple) seems me taviwrite. tried taviwriter did not succeed. in procedure taviwriter.write; function call around line 370 avierr := avisavev(s, // pchar(filename), nil, // file handler nil, // callback nstreams, // number of streams streams, compoptions); // compress options
Read more

jasper reports - Fixed header in Excel using JasperReports -

-
how can create excel report fixed header using japserreports? mean need header fixed when scroll excel file. this possible adding couple properties in jrxml file each report. take @ advanced excel features freeze panes. if wanted freeze after first column header (down left side basically) this: <statictext> <reportelement style="sans_bold" mode="opaque" x="0" y="60" width="104" height="20" forecolor="#ffffff" backcolor="#666666"> <property name="net.sf.jasperreports.export.xls.auto.filter" value="start"/> <property name="net.sf.jasperreports.export.xls.column.width" value="110"/> <property name="net.sf.jasperreports.export.xls.freeze.column.edge" value="left"/> </reportelement> &
Read more

python - ('The SQL contains 0 parameter markers, but 50 parameters were supplied', 'HY000') or TypeError: 'tuple' object is not callable -

-
import pyodbc,nltk,array cnxn = pyodbc.connect('driver={mysql odbc 5.1 driver};server=127.0.0.1;port=3306;database=information_schema;user=root; password=1234;option=3;') cursor = cnxn.cursor() cursor.execute("use collegedatabase ;") cursor.execute("select * sampledata ; ") cnxn.commit() s=[] j=[] x=[] words = [] w = [] sfq = [] pos=[] entry in cursor: s.append(entry.injury_type),j.append(entry.injury_desc) nltk.tokenize import punktwordtokenizer nltk.corpus import stopwords tokenizer = punktwordtokenizer() english_stops = set(stopwords.words('english')) in range(0,26): # filter stop words tokenizer.tokenize(j[i]) w.append([word word in tokenizer.tokenize(j[i]) if word not in english_stops]) in range(0 , 26):#converting tokenzied text ito string sfq.append(" ".join(w[a])) replacers import regexpreplacer replacer = regexpreplacer() in range (0,26):#pos tagging replacer.repl
Read more