Skip to content

Documentation for gcCorrectMain needed #4

@rscharpf

Description

@rscharpf

We need documentation for exported functions. You should explicitly export gcCorrectMain in the NAMESPACE and provide a description of arguments. A working example(s) is essential so that users can format their data similarly. Users should be able to run the example by typing

example(gcCorrectMain)

at the R prompt.

Currently, we have to do some work to get the data in the right format to call gcCorrectMain. You might consider writing an S4 method 'gcCorrect' that takes the arguments 'object' and '...'. When object has class matrix (a matrix of M values), the method calls the internal function gcCorrectMain directly. If object is one of the classes in oligoClasses package (e.g, the class mike is working with), we can then add a method for gcCorrect that does the reformatting and calls gcCorrectMain.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions