Project

General

Profile

Task #3543

Story #3433: adapt R Client methods to fit in with R community expectations

adjust documentation to match S4 expectations

Added by Rob Nahf over 11 years ago. Updated over 11 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Target version:
Start date:
2013-01-31
Due date:
% Done:

100%

Estimated time:
0.00 h
Milestone:
None
Story Points:
Sprint:

Description

roxygen2 doesn't handle S4 methods very well (and doesn't support package and class documentation), and I found specific guidance from the R core team on how to do it, need to adjust the documentation. (http://cran.r-project.org/doc/manuals/r-release/R-exts.pdf, section 2.1.3)

will use:

promptMethods(methodName),
promptClass(className),
promptPackage(packageName)

History

#1 Updated by Rob Nahf over 11 years ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100
  • translation missing: en.field_remaining_hours set to 0.0

managed to maintain a class-oriented view of method description, through use of promptClass, prompt
and attaching all of the aliases in those classes.

#2 Updated by Matthew Jones over 11 years ago

  • Target version deleted (2013.2-Block.1.1)

#3 Updated by Rob Nahf over 11 years ago

  • Target version set to DataONE R Client 1.0.0

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 14.8 MB)