search

r-bioinformatics / edgePy

A Python implementation of edgeR for differential expression analysis
https://edgepy.readthedocs.io
MIT License
96 stars 10 forks source link

Add documentation for io submodule #52

Closed Carbyne closed 6 years ago

Carbyne commented 6 years ago

The io submodule needs docstrings and documentation regarding which kinds of paths smart_open can handle (ex. local compressed/uncompressed files, S3/Hadoop/HTTP servers).

apfejes commented 6 years ago

This module is now renamed to data_import (post merge of PR #40). io is a reserved package name and shouldn't be reused.

apfejes commented 6 years ago

@Carbyne - Since we're using an outside library, shouldn't we just point to the document there, so that we don't have to maintain a list?

https://github.com/RaRe-Technologies/smart_open/blob/master/README.rst

Carbyne commented 6 years ago

@apfejes Yeah, that would be a better solution. The only problem I could see would be if they changed something in a newer version of smart_open and we were still using an older version.

apfejes commented 6 years ago

That shouldn't happen, as requirements are given in the ">=" form, so any new install should bring along a new version.

joshuak94 commented 6 years ago

Okay to close the issue?

apfejes commented 6 years ago

I think so. Closing. If anyone objects, reopen.