Open booker-tremayne opened 3 years ago
I have fixed most of the warnings / notes; however, one remains. Here it is:
checking for missing documentation entries ... WARNING Undocumented code objects: 'accession' 'accession<-' 'affiliations' 'affiliations<-' 'data.processing.protocol' 'data.processing.protocol<-' 'diseases' 'diseases<-' 'download.link' 'download.link<-' 'file.bytes' 'file.bytes<-' 'file.name' 'file.name<-' 'file.type' 'file.type<-' 'identified.ptm.strings' 'identified.ptm.strings<-' 'instruments' 'instruments<-' 'lab.PIs' 'lab.PIs<-' 'organism.parts' 'organism.parts<-' 'organisms' 'organisms<-' 'project.accession' 'project.accession<-' 'project.description' 'project.description<-' 'project.tags' 'project.tags<-' 'project.title' 'project.title<-' 'publication.date' 'publication.date<-' 'quantification.methods' 'quantification.methods<-' 'sample.processing.protocol' 'sample.processing.protocol<-' 'submission.type' 'submission.type<-' 'submitters' 'submitters<-' All user-level objects in a package should have documentation entries. See chapter 'Writing R documentation files' in the 'Writing R Extensions' manual.
See here for how to document multiple functions on the same page using:
https://gist.github.com/jefferys/b79fe87314b0dc72fec9
I would use the second approach using @rdname here.
I have fixed most of the warnings / notes; however, one remains. Here it is:
checking for missing documentation entries ... WARNING Undocumented code objects: 'accession' 'accession<-' 'affiliations' 'affiliations<-' 'data.processing.protocol' 'data.processing.protocol<-' 'diseases' 'diseases<-' 'download.link' 'download.link<-' 'file.bytes' 'file.bytes<-' 'file.name' 'file.name<-' 'file.type' 'file.type<-' 'identified.ptm.strings' 'identified.ptm.strings<-' 'instruments' 'instruments<-' 'lab.PIs' 'lab.PIs<-' 'organism.parts' 'organism.parts<-' 'organisms' 'organisms<-' 'project.accession' 'project.accession<-' 'project.description' 'project.description<-' 'project.tags' 'project.tags<-' 'project.title' 'project.title<-' 'publication.date' 'publication.date<-' 'quantification.methods' 'quantification.methods<-' 'sample.processing.protocol' 'sample.processing.protocol<-' 'submission.type' 'submission.type<-' 'submitters' 'submitters<-' All user-level objects in a package should have documentation entries. See chapter 'Writing R documentation files' in the 'Writing R Extensions' manual.