Page MenuHomePhabricator
Create Task
Maniphest T27775

only export functions to be used by user
Open, LowPublic
Actions

Description

in NAMESPACE only functions should be exported which are intended to be used by user, not internal functions and only top level S3 function.

to be done before finalization of version 1

Event Timeline

wiesenfa triaged this task as Low priority.Sep 24 2020, 3:17 PM
wiesenfa created this task.
wiesenfa added subscribers: eisenman, • aguilera, reinkea.
eisenman added a comment.Nov 4 2020, 7:39 PM

I started with the roxygen documentation and found that the NAMESPACE file can be generated automatically by using the "export" tag.

wiesenfa added a comment.Nov 4 2020, 8:05 PM

also roxygen import and also intitialization of S3 methods have to be written in roxygen then and the namespace file is then entirely written by roxygenization (ideally indcluding help)

wiesenfa added a comment.Dec 7 2020, 1:10 PM

@eisenman do you want to do this with roxygen?

eisenman edited projects, added challengeR; removed challengeR (v1.0).Dec 17 2020, 12:13 AM

Discussed with @wiesenfa that this issue is not critical for release v1.0.

MITK · MIC · IMSY · DKFZ