[Rd] Problem with build and check

[William Dunlap]

'Writing R Extensions', section 2.1 Rd format, says"

Comments run from a percent symbol % to the end of the line in all types of
text (as on the first line of the load example).

Because backslashes, braces and percent symbols have special meaning, to
enter them into text sometimes requires escapes using a backslash. In
general balanced braces do not need to be escaped, but percent symbols
always do. For the complete list of macros and rules for escapes, see “Parsing
Rd files” <http://developer.r-project.org/parseRd.pdf>.




Bill Dunlap
TIBCO Software
wdunlap tibco.com

On Wed, Nov 12, 2014 at 11:11 AM, Therneau, Terry M., Ph.D. <
therneau at mayo.edu> wrote:

> I am getting failure of build and check, for an Rd file that has a long
> argument list.
> Guess diagnosis: a quoted string beyond a certain point in the argument
> list is fatal.
>
> Example:  Use the function below, create an Rd file for it with prompt().
> Move the .Rd file to the man directory (no need to edit it) and try building
>
> dart.control <- function(server=c("production", "integration",
> "development",
>                                   "http"),
>                          out.poll.duration = 5,
>                          out.poll.increase = 1.1,
>                          out.poll.max = 30,
>                          out.poll.timeout = 3600,
>                          netrc.path,
>                          netrc.server = "ldap",
>                          rtype = c("xml", "json"),
>                          dateformat= "%Y-%m-%d") {
>
>     server <- match.arg(server)
>     server
> }
>
> I created a package "dummy" with only this function, and get the following
> on my Linux box.
>
> tmt-local2021% R CMD build dummy
> * checking for file ‘dummy/DESCRIPTION’ ... OK
> * preparing ‘dummy’:
> * checking DESCRIPTION meta-information ... OK
> Warning: newline within quoted string at dart.control.Rd:11
> Warning: /tmp/RtmpjPjz9V/Rbuild398d6e382572/dummy/man/dart.control.Rd:46:
> unexpected section header '\value'
> Warning: newline within quoted string at dart.control.Rd:11
> Error in parse_Rd("/tmp/RtmpjPjz9V/Rbuild398d6e382572/dummy/man/dart.control.Rd",
> :
>   Unexpected end of input (in " quoted string opened at
> dart.control.Rd:88:16)
> Execution halted
>
> Session info for my version
> > sessionInfo()
> R Under development (unstable) (2014-10-30 r66907)
> Platform: i686-pc-linux-gnu (32-bit)
>
> locale:
>  [1] LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C
>  [3] LC_TIME=en_US.UTF-8        LC_COLLATE=C
>  [5] LC_MONETARY=en_US.UTF-8    LC_MESSAGES=en_US.UTF-8
>  [7] LC_PAPER=en_US.UTF-8       LC_NAME=C
>  [9] LC_ADDRESS=C               LC_TELEPHONE=C
> [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C
>
> attached base packages:
> [1] stats     graphics  grDevices utils     datasets  methods base
>
>
> Terry T.
>
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>

	[[alternative HTML version deleted]]