lgatto / pRolocdata

Data accompanying the pRoloc package
5 stars 5 forks source link

Krahmer2018 #44

Closed ococrook closed 5 years ago

ococrook commented 5 years ago

Phospho peptide data from krahmer et al.

adding R script updated Readme added rda file added documentation

checked locally

ococrook commented 5 years ago

@lgatto this should cover #44 and #36

lgatto commented 5 years ago

Thanks @ococrook.

I would suggest to document krahmer2018pcp and krahmer2018Phosphopcp. This makes it easier, when reading up one dataset, to be made aware (or reminded) of the other one. For that, in addition to combining unique sections, you also need to add an alias with the name of the second dataset in the first man page.

Also, could you use all lowercase, renaming it to krahmer2018phosphopcp - it's easier to remember all lowercase, rather than only first P after the date is capitalised.

ococrook commented 5 years ago

Great, quick questions 1) Do we still keep two man pages? 2) \alias{dataset1} \alias{dataset2} on different lines 3) did by any chance you mean usage rather than unique?

lgatto commented 5 years ago

Only one man page, for instance krahmer2018pcp.Rd, that has

\alias{krahmer2018pcp} 
\alias{krahmer2018phosphopcp}

I meant unique. Some parts of the documentation are the same, some other part will be specific (unique) to phospho, for example.