[Bioc-devel] documentation of raw data
In general the documentation in inst/scripts can be code, sudo code, or text but should indicate the source of the data and how it was generated and other useful information for using the data. Think of it as a how to if a user wanted to mimic or recreate the data you are providing. Cheers, Lori Shepherd Bioconductor Core Team Roswell Park Comprehensive Cancer Center Department of Biostatistics & Bioinformatics Elm & Carlton Streets Buffalo, New York 14263
From: Bioc-devel <bioc-devel-bounces at r-project.org> on behalf of Severin Bang <severin.bang at physik.uni-freiburg.de>
Sent: Thursday, April 29, 2021 5:31 AM
To: bioc-devel at r-project.org <bioc-devel at r-project.org>
Subject: [Bioc-devel] documentation of raw data
Sent: Thursday, April 29, 2021 5:31 AM
To: bioc-devel at r-project.org <bioc-devel at r-project.org>
Subject: [Bioc-devel] documentation of raw data
Dear all, I plan to provide at least two .csv files of raw data for the package I want to publish on Bioconductor. In point 5.4 of https://secure-web.cisco.com/1fgTuNMvqaOq1N6s7Udxp2_eP_W4th1D0KIAvpAItuhiTWG7jCXYK3saVlP1lVZfR851D2SYk47AtHQ_btlXWjgOESvKpAHG6oUrRVCJqJkIvyhDnxQQusZvGs1XHbctAOxF7vodtO-2rMNfLaRz2kWKUNyV5anop76v5gxMhWzbO32fWlrWXouRPYAUb0lMvG8iY1ES13hJlz9D1tqFPTxQbrGuh8jivKoL_AICy_JrgUv2-MtnL3qc8xYe7imLd3vUZ_nhfQnVR-KOgO1m-crY8BKycdS_gLcr2ql3oHZ_7gcKhO2PeZspSe8N6M3zG/https%3A%2F%2Fwww.bioconductor.org%2Fdevelopers%2Fpackage-guidelines%2F%23data it is stated that such data needs to be documented in the inst/script/ directory. Sadly I could not find a more explicit description of what this means. For functions I use roxygen to build the documentation, how do is this tool used to build documentation for raw data? What requirements are there for the documentation? I plan to describe the general purpose and the significance of each column in particular, are there more points that should be covered? Many thanks in advance! Best Severin _______________________________________________ Bioc-devel at r-project.org mailing list https://secure-web.cisco.com/1IhK8ig18NB9x8zzDIZUFV_KVJaA8icmLyZCCtaUi7dlrJeT7YnNmyLX62fnR39Qr02SUw3m7pFCEIimdxjQ-DcXas15OqFbMAi9lY4IQK1hZPsQ6ucQc5gnqCfwoIPYyTFWivJYnmkOTPrUxwibqQjrbtw1yKXzfYq7a7okz_YLpY8Pj_mB3GExyMx9sLM5uGM5VuRFdMZnvT45u5Dkpz2KQPLhl04cS56I7Hmn5ylWUE5VYqUjXEHtEgevq5qs_43WelANAnwZ5tIX9-DTA8WR7qJV1nr_bYFOqxlABDNkAY9vpbNsmMFxqc5wlGouU/https%3A%2F%2Fstat.ethz.ch%2Fmailman%2Flistinfo%2Fbioc-devel This email message may contain legally privileged and/or confidential information. If you are not the intended recipient(s), or the employee or agent responsible for the delivery of this message to the intended recipient(s), you are hereby notified that any disclosure, copying, distribution, or use of this email message is prohibited. If you have received this message in error, please notify the sender immediately by e-mail and delete this email message from your computer. Thank you.