Как избежать% в грамотном программировании? - PullRequest
Новая
       26

Как избежать% в грамотном программировании?

11 голосов
/ 02 апреля 2010

Значение по умолчанию для параметра моей функции содержит «%». Это кажется проблемой для roxygen, он выдает много предупреждений и R CMD проверяет неудачу при попытке создать латексную документацию.

Как я могу заставить эту функцию (и ее документацию) работать? Использование %% или \% вместо% не помогает. 

#' Test escape \% from in-source documentation (roxygen).
#'
#' What happens when parameters contain special latex characters? 
#'
#' @param x unsuspicious parameter 
#' @param format sprintf format string (default "\%5.0f")
#'
#' @return formatted string
#' @export
#' @author Karsten Weinert
testroxy <- function(x, format = "%5.0f") {
  sprintf(format,x)
}

Ответы [ 2 ]

7 голосов
/ 22 июня 2016

Код, похожий на тот, что в вопросе, работает для меня без проблем и генерирует правильную документацию. Как говорится в нескольких комментариях, причина в том, что я использую пакет roxygen2. Так что просто используйте roxygen2, а затем экранируйте "%" в документации, используя обратную косую черту: 

#' The percentage sign is written in the documentation like this: \%.
6 голосов
/ 23 декабря 2011 
#!/usr/bin/perl
use strict;
use File::Temp qw/tempfile/;
use File::Copy;

my $usage = <<EOD

  $0 file1.Rd [file2.Rd ...]

  When using roxygen to generate documentation for an R pacakge, if a default
  argument has a percent sign in it then roxygen will copy it directly into
  the .Rd file. Since .Rd is basically latex, this will be interpreted as a
  comment and case the file to be parsed incorrectly.

  For percent signs elsewhere in your documentation, for example in the
  description of one of the parameters, you should use "\%" so parse_Rd
  interprets it correctly.

  But you cannot do this in the default arguments because they have to be
  valid R code, too.

  Since the .Rd files are automatically generated they should not have
  any latex comments in them anyway.

  This script escapes every unescaped % within the file.

  The .Rd files are modified in place, since it would be easy to
  generate them again with R CMD roxygen.

EOD
;

my $n_tot = 0;
my $n_file = @ARGV;
my $n_esc_file = 0;
foreach my $fn (@ARGV)  {

  print STDERR ' ' x 100, "\rWorking on $fn\t";
  open my $fh, $fn or die "Couldn't open $fn: $!";
  my ($tmp_fh, $tmp_fn) = tempfile();

  my $n;
  while(<$fh>)  {
    $n += s/(?<!\\)%/\\%/g;  # if % is not preceded with backslash then replace it with '\%'
    print $tmp_fh $_;
  }
  $n_tot += $n;
  $n_esc_file ++ if $n;
  print "Escaped $n '%'\n" if $n;
  close $tmp_fh;
  move($tmp_fn => $fn);
}

print "\n";

print "$n_file files parsed\n";
print "$n_esc_file contained at least one unescaped %\n";
print "$n_tot total % were escaped\n";

Это моё неумелое решение. Сохраните скрипт perl как, например, escape_percents.pl, тогда последовательность будет такой: 

R CMD roxygen my.package
perl escape_percents.pl my.package.roxygen/man/*.Rd
R CMD install my.package.roxygen

Это может создать больше проблем, например, если у вас есть пример кода с использованием %% в качестве оператора модуля, но это было удобно для меня.

...