← Back to branch summary

~showard314/ubuntu/karmic/r-base/remove_start_comments

« back to all changes in this revision

Viewing changes to doc/manual/R-exts.texi

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2008-12-20 09:26:38 UTC
  • mfrom: (1.2.6 upstream)
  • mto: (2.1.32 jaunty)
  • mto: This revision was merged to the branch mainline in revision 6.
  • Revision ID: james.westby@ubuntu.com-20081220092638-i4p6po0hndi24ri5
* Updated to Dec 19 release candidate of R 2.8.1 expected for Dec 22

* r-doc-pdf expected to be empty due to the tex/texinfo bug below

* debian/control: Change Build-Depends: on openjdk-6-jdk to 
  'openjdk-6-jdk [!arm !hppa]' as arm and hppa do not have one.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manual/R-exts.texi
360
360
@file{README} file.  The @R{} @command{INSTALL} facilities check if the
361
361
version of @R{} used is recent enough for the package being installed,
362
362
and the list of packages which is specified will be attached (after
363
 
checking version dependencies) before the current package, both when
 
363
checking version requirements) before the current package, both when
364
364
@code{library} is called and when saving an image of the package's code
365
365
or preparing for lazy-loading.
366
366
 
376
376
field will include all the standard packages, and it is important to
377
377
include S4-using packages (as their class definitions can change and the
378
378
@file{DESCRIPTION} file is used to decide which packages to re-install
379
 
when this happens).
 
379
when this happens).  Packages declared in the @samp{Depends} field
 
380
should not also be in the @samp{Imports} field.  Versions can be
 
381
specified, but will not be checked when the namespace is loaded.
380
382
 
381
383
The optional @samp{Suggests} field uses the same syntax as
382
384
@samp{Depends} and lists packages that are not necessarily needed.  This
397
399
@item
398
400
Packages whose name space only is needed to load the package using
399
401
@code{library(@var{pkgname})} must be listed in the @samp{Imports}
400
 
field.
 
402
field and not in the @samp{Depends} field.
401
403
@item
402
404
Packages that need to be attached to successfully load the package using
403
405
@code{library(@var{pkgname})} must be listed in the @samp{Depends}
404
 
field.
 
406
field, only.
405
407
@item
406
408
All packages that are needed to successfully run @code{R CMD check} on
407
409
the package must be listed in one of @samp{Depends} or @samp{Suggests}
413
415
vignettes should be listed in @samp{Suggests} rather than @samp{Depends}
414
416
in order to make lean installations possible.
415
417
 
 
418
Currently adding version dependencies for packages only makes sense for
 
419
the @samp{Depends} field, as only @code{library} checks version
 
420
requirements, and only for the packages it loads via the @samp{Depends}
 
421
field.
 
422
 
416
423
The optional @samp{URL} field may give a list of @acronym{URL}s
417
424
separated by commas or whitespace, for example the homepage of the
418
425
author or a page where additional material describing the software can
3873
3880
 
3874
3881
A @code{\value} block is implicitly a @code{\itemize} environment, but
3875
3882
quite a few package writers have ignored this.  As from @R{} 2.8.1 this
3876
 
is detected and a warning given.  Future versions of @R{} will remove
3877
 
such @code{\itemize} commands.
 
3883
is detected, and the @code{\itemize} command (but not its contents)
 
3884
removed, with a warning.
3878
3885
 
3879
3886
 
3880
3887
@node Tidying and profiling R code, Debugging, Writing R documentation files, Top
10134
10141
@file{@var{R_HOME}/bin} is in your @env{PATH} so the @R{} DLLs are found.
10135
10142
 
10136
10143
Examples of calling @file{R.dll} directly are provided in the directory
10137
 
@file{src/@/gnuwin32/@/front-ends}, including @file{Rproxy.dll} used by
10138
 
@code{StatConnector} and a simple command-line front end @file{rtest.c}
10139
 
whose code is
 
10144
@file{src/@/gnuwin32/@/front-ends}, including a simple command-line
 
10145
front end @file{rtest.c} whose code is
10140
10146
 
10141
10147
@smallexample
10142
10148
#define Win32
10147
10153
#include <Rembedded.h>
10148
10154
#include <R_ext/RStartup.h>
10149
10155
/* for askok and askyesnocancel */
10150
 
#include <graphapp/graphapp.h>
 
10156
#include <graphapp.h>
10151
10157
 
10152
10158
/* for signal-handling code */
10153
10159
#include <psignal.h>
10170
10176
    printf("%s", buf);
10171
10177
@}
10172
10178
 
10173
 
void myCallBack()
 
10179
void myCallBack(void)
10174
10180
@{
10175
10181
    /* called during i/o, eval, graphics in ProcessEvents */
10176
10182
@}