Roxygen2: <environment: 0x3b90500> in .Rd files

Created on 2 Mar 2017 · 23Comments · Source: r-lib/roxygen2

With roxygen2 version 6.0.1 from CRAN (published 2017-02-06), I am not able to generate meaningful .Rd files. I am on Ubuntu Linux, and I tried the following setup:

DESCRIPTION file:

Package: test
Type: Package
Title: What the Package Does (Title Case)
Version: 0.1.0
Author: Who wrote it
Maintainer: The package maintainer <[email protected]>
Description: More about what it does (maybe more than one line)
    Use four spaces when indenting paragraphs within the Description.
License: What license is it under?
Encoding: UTF-8
LazyData: true

R/hello.R file:

# Hello, world!
#
# This is an example function named 'hello'
# which prints 'Hello, world!'.
#
# You can learn more about package authoring with RStudio at:
#
#   http://r-pkgs.had.co.nz/
#
# Some useful keyboard shortcuts for package authoring:
#
#   Build and Reload Package:  'Ctrl + Shift + B'
#   Check Package:             'Ctrl + Shift + E'
#   Test Package:              'Ctrl + Shift + T'

#' Test
#'
#' Test2
#' @export
hello <- function() {
  print("Hello, world!")
}

When I do this:

library("roxygen2")
roxygenize()

I get a NAMESPACE file and a man/hello.Rd file with 25 bytes and the following contents:

<environment: 0x3b90500>

I guess this is not what is supposed to be in the .Rd file, right?

I downloaded roxygen2 version 5.0.1 from CRAN and tried that version instead, and now it produces the following contents instead, which looks more like what I was expecting:

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/hello.R
\name{hello}
\alias{hello}
\title{Test}
\usage{
hello()
}
\description{
Test2
}

Any idea what the problem is? Thanks for any hints!

Source

leifeld

👍1

Most helpful comment

Can you try installing the latest version of R6?

hadley on 13 Mar 2017

👍3

All 23 comments

Please provide a reproducible example. This will probably involve creating a minimal package that I can download and run roxygenise() on.

hadley on 7 Mar 2017

The same is happening to me. I'm trying to write my very first package.
https://github.com/jcpsantiago/ISIcalc I uploaded my code here. Very basic but it should work as a reproducible example?

I'm on Arch Linux, R3.3.3, Rstudio 1.0.136, Roxygen2 6.0.1

jcpsantiago on 8 Mar 2017

Ideally it would be minimal - i.e. A single documented function

hadley on 8 Mar 2017

Something like this? I reduced it to include a single documented function.
ISIcalc_0.1.0.tar.gz

jcpsantiago on 9 Mar 2017

I cannot reproduce this with my setup. Can you pls send the output of devtools::session_info()?

❯ devtools::session_info()
Session info -------------------------------------------------------------------
 setting  value
 version  R version 3.3.2 (2016-10-31)
 system   x86_64, darwin13.4.0
 ui       X11
 language (EN)
 collate  en_US.UTF-8
 tz       Europe/London
 date     2017-03-10

Packages -----------------------------------------------------------------------
 package    * version date       source
 assertthat   0.1     2013-12-06 CRAN (R 3.3.0)
 backports    1.0.5   2017-01-18 CRAN (R 3.3.2)
 clisymbols   1.1.0   2017-02-07 local
 commonmark   1.2     2017-03-01 CRAN (R 3.3.2)
 crayon       1.3.2   2016-06-28 CRAN (R 3.3.0)
 desc         1.1.0   2017-01-27 local (metacran/description@e728f18)
 devtools     1.12.0  2016-06-24 CRAN (R 3.3.0)
 digest       0.6.12  2017-01-27 CRAN (R 3.3.2)
 gitty        1.0.0   2016-12-25 local
 ISIcalc    * 0.1.0   <NA>       local
 magrittr     1.5     2014-11-22 CRAN (R 3.3.0)
 memoise      1.0.0   2016-01-29 CRAN (R 3.3.0)
 memuse       3.0-1   2016-09-20 CRAN (R 3.3.0)
 prettycode * 1.0.0   2017-01-27 Github (gaborcsardi/prettycode@61f51f8)
 prompt       1.0.0   2016-12-25 local
 R6           2.2.0   2016-10-05 CRAN (R 3.3.0)
 Rcpp         0.12.9  2017-01-14 CRAN (R 3.3.2)
 roxygen2     6.0.1   2017-02-06 CRAN (R 3.3.2)
 rprojroot    1.2     2017-01-16 CRAN (R 3.3.2)
 stringi      1.1.2   2016-10-01 CRAN (R 3.3.0)
 stringr      1.2.0   2017-02-18 CRAN (R 3.3.2)
 tracer     * 1.0.0   2017-01-27 local (gaborcsardi/tracer@NA)
 whisker      0.3-2   2013-04-28 CRAN (R 3.3.0)
 withr        1.0.2   2016-06-20 CRAN (R 3.3.0)
 xml2         1.1.1   2017-01-24 CRAN (R 3.3.2)