Skip to content

Documentation clash with network candidate 1.20.0 #27

@CarterButts

Description

@CarterButts

OK, we have folded in Pavel's proposed changes to network, which make a lot more things generic. revdepcheck suggests no major issues, except that networkDynamic shows the following:

 ```
 S3 methods shown with full name in Rd file 'network.extensions.Rd':
   ‘get.edgeIDs.active’ ‘get.edges.active’ ‘get.neighborhood.active’
   ‘is.adjacent.active’
 
 The \usage entries for S3 methods should use the \method markup and not
 their full name.
 See chapter ‘Writing R documentation files’ in the ‘Writing R
 Extensions’ manual.
 ```

This is because get.edgeIDs, get.edges, get.neighborhood, and is.adjacent are now S3 generics. Thus, R thinks that get.edges.active is a method, and is upset at the docs.

The fix I have used for the same kind of issue in the sna package has been to just write the command as if it is a method, e.g.

\method{as.edges}{active}(blah blah)

This seems to calm down the CRAN checks, at least for now.

I can try to implement a fix, or someone else can do so....

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions