[Bioc-devel] How to use RData files in Bioconductor data and software packages
web working
webwork|ng @end|ng |rom po@teo@de
Thu Jan 16 16:25:50 CET 2020
Hi Herve,
thank you for your answer. To be honest I am fine if the data sets can
not be loaded with data() solution.
Falsely I said a warning occurred during the BiocCheck. A warning
occurred during the R check command of my data package. I used the
recommended R CMD check environment flags for the check of my package
(https://github.com/Bioconductor/Contributions/blob/master/CONTRIBUTING.md#r-cmd-check-environment)
(devtools::check(document = FALSE, args = c('--no-build-vignettes'),
build_args = c('--resave-data','--no-build-vignettes'))).
During the "Building" step of the R CMD check some "strange" behavior
occurs. A lot of characters are printed at the screen:
...
─ checking for empty or unneeded directories
─ looking to see if a ‘data/datalist’ file should be added
dispersionFunction
fitType
varLogDispEsts
dispPriorVar
dispFunction
fit
d
means
disps
minDisp
<environment: 0x55c0074c3280>
means
class
class
class
class
rowRanges
unlistData
elementMetadata
elementType
metadata
partitioning
class
colData
rownames
nrows
listData
[1]
[2]
elementType
...
At the "Checking" step I got a warning with the same effect:
...
* checking Rd cross-references ... OK
* checking for missing documentation entries ... OK
* checking for code/documentation mismatches ... WARNING
[3]
[4]
[5]
<environment: 0x558ca7e143a8>
[6]
<environment: base>
names
[2]
[3]
[4]
[5]
names
dispersionFunction
fitType
varLogDispEsts
dispPriorVar
[1]
[1]
[1]
[2]
names
class
row.names
[2]
<environment: 0x558cc57da100>
means
class
...
This warning only occurs if I store my RData files in the data directory.
Here an example of the Class object I store in the RData file:
#' @rdname dummyDataSet
setClass("dummyDataSet", slots = c(dds = "list",
genes = "GenomicRanges",
bamFiles = "list",
resultTables = "list",
treatment = "character",
nameAnalysis = "character",
numberOfCores = "numeric"),
validity = function(object) {
...
}, contains = "dummySoftware")
My class exists of some lists of data.frames (e.g. resultTables), lists
of S4 objects (e.g. list of DESeq2 objects (dds)), S4 objects (e.g.
genes) and more. Maybe this is the reason why I got this "strange" behavior?
If you need some more information, just let me know.
Here my sessionInfo:
> sessionInfo()
R version 3.6.1 (2019-07-05)
Platform: x86_64-pc-linux-gnu (64-bit)
Running under: Ubuntu 18.04.3 LTS
Matrix products: default
BLAS: /home/x/Programme/R_Versions/R-3.6.1/lib/libRblas.so
LAPACK: /home/x/Programme/R_Versions/R-3.6.1/lib/libRlapack.so
locale:
[1] LC_CTYPE=de_DE.UTF-8 LC_NUMERIC=C LC_TIME=de_DE.UTF-8
LC_COLLATE=de_DE.UTF-8 LC_MONETARY=de_DE.UTF-8
[6] LC_MESSAGES=de_DE.UTF-8 LC_PAPER=de_DE.UTF-8
LC_NAME=C LC_ADDRESS=C LC_TELEPHONE=C
[11] LC_MEASUREMENT=de_DE.UTF-8 LC_IDENTIFICATION=C
attached base packages:
[1] stats graphics grDevices utils datasets methods base
other attached packages:
[1] dummyData_0.1.0
loaded via a namespace (and not attached):
[1] compiler_3.6.1 tools_3.6.1 yaml_2.2.0
Best,
Tobias
Am 09.01.20 um 22:40 schrieb Pages, Herve:
> On 1/9/20 13:00, web working wrote:
>> Hi Herve,
>>
>> thank you for your detailed answer. I guess I have expressed myself
>> unclear. The BED files were just examples for data I store in the
>> inst/extdata folder. Based on the description for ExperimentHubData I
>> have decided to create a software and a data package (no
>> ExperimentHubData software package). In my RData files I store software
>> package objects. These objects are bigger than 5 MB. Using a helper
>> function is no option, because the object calculation takes to much
>> time. For this reason I want to load this objects for my example
>> functions. My question is if the storage of my RData files in the
>> inst/extdata directory is correct or not.
> It's technically correct but it's not as convenient as putting them in
> data/ because they can not longer be listed and/or loaded with data().
> So if you're storing them in inst/extdata only because the data()
> solution gave you a BiocCheck warning then I'd say that you're giving up
> too easily ;-)
>
> IMO it is important to try to understand why the data() solution gave
> you a BiocCheck warning in the first place. Unfortunately you're not
> providing enough information for us to be able to tell. What does the
> warning say? How can we reproduce the warning? Ideally we would need to
> see a transcript of your session and links to your packages.
>
> Thanks,
> H.
>
>
>> Best,
>>
>> Tobias
>>
>> Am 09.01.20 um 17:59 schrieb Pages, Herve:
>>> Hi Tobias,
>>>
>>> If the original data is in BED files, there should be no need to
>>> serialize the objects obtained by importing the files. It is **much**
>>> better to provide a small helper function that creates an object from a
>>> BED file and to use that function each time you need to load an object.
>>>
>>> This has at least 2 advantages:
>>> 1. It avoids redundant storage of the data.
>>> 2. By avoiding serialization of high-level S4 objects, it makes the
>>> package easier to maintain in the long run.
>>>
>>> Note that the helper function could also implement a cache mechanism
>>> (easy to do with an environment) so the BED file is only loaded and the
>>> object created the 1st time the function is called. On subsequent calls,
>>> the object is retrieved from the cache.
>>>
>>> However, if the BED files are really big (e.g. > 50 Mb), we require them
>>> to be stored on ExperimentHub instead of inside dummyData. Note that you
>>> still need to provide the dummyData package (which becomes what we call
>>> an ExperimentHub-based data package). See the "Creating An ExperimentHub
>>> Package" vignette in the ExperimentHubData package for more information
>>> about this.
>>>
>>> Hope this helps,
>>>
>>> H.
>>>
>>> On 1/9/20 04:45, web working wrote:
>>>> Dear all,
>>>>
>>>> I am currently developing a software package (dummySoftware) and a data
>>>> package (dummyData) and I am a bit confused in where to store my RData
>>>> files in the data package. Here my situation:
>>>>
>>>> I want to store some software package objects (new class objects of the
>>>> software package) in the data package. This objects are example objects
>>>> and a to big for software packages. As I have read here
>>>> (https://urldefense.proofpoint.com/v2/url?u=http-3A__r-2Dpkgs.had.co.nz_data.html&d=DwICAg&c=eRAMFD45gAfqt84VtBcfhQ&r=BK7q3XeAvimeWdGbWY_wJYbW0WYiZvSXAJJKaaPhzWA&m=GaTKqVd_WDqMRk0dW7SYkjVlgCzt0I0bACHfb1iIOVc&s=0ajhWDlJfLxXxzJpreO1Nh4qnu3aJ8gQkRb9qThsi1o&e=
>>>>
>>>> ) all RData objects should be stored in the data directory of a package.
>>>> BED files of the data package are stored in inst/extdata.
>>>> The data of the data packaged will be addressed in the software package
>>>> like this: system.file('extdata', 'subset.bed', package = 'dummyData').
>>>> And here the problem occurs. After building the data package
>>>> (devtools::build(args = c('--resave-data'))), all data in data/ are
>>>> stored in a datalist, Rdata.rdb, Rdata.rds and Rdata.rdx and can not
>>>> addressed with system.file. Addressing this data with the data()
>>>> function results in a warning during BiocCheck::BiocCheck().
>>>>
>>>> My solution is to store the RData files in the inst/extdata directory
>>>> and address them with system.file. Something similar is mentioned here,
>>>> but in the context of a vignette
>>>> (r-pkgs.had.co.nz/data.html#other-data). Is this the way how to do it?
>>>>
>>>> Best,
>>>> Tobias
>>>>
>>>> _______________________________________________
>>>> Bioc-devel using r-project.org mailing list
>>>> https://urldefense.proofpoint.com/v2/url?u=https-3A__stat.ethz.ch_mailman_listinfo_bioc-2Ddevel&d=DwICAg&c=eRAMFD45gAfqt84VtBcfhQ&r=BK7q3XeAvimeWdGbWY_wJYbW0WYiZvSXAJJKaaPhzWA&m=GaTKqVd_WDqMRk0dW7SYkjVlgCzt0I0bACHfb1iIOVc&s=GYaoH8LeSP0tdY4PoOHEdDMGhzLC2gHcNGtKjVLZV-8&e=
>>>>
>>>>
>> _______________________________________________
>> Bioc-devel using r-project.org mailing list
>> https://urldefense.proofpoint.com/v2/url?u=https-3A__stat.ethz.ch_mailman_listinfo_bioc-2Ddevel&d=DwICAg&c=eRAMFD45gAfqt84VtBcfhQ&r=BK7q3XeAvimeWdGbWY_wJYbW0WYiZvSXAJJKaaPhzWA&m=Qwx6C4UGtdKkDQNJBk3T8CAyjLptT_qPz1HFj8qb5l0&s=ujZIxuMXFvoAkJIgZhZZ4XURLlpCxhqdrY9Bma2xAlc&e=
>>
More information about the Bioc-devel
mailing list