Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unified documentation for setup #3

Open
standage opened this issue Aug 25, 2015 · 0 comments
Open

Unified documentation for setup #3

standage opened this issue Aug 25, 2015 · 0 comments

Comments

@standage
Copy link
Member

The TRegGA configuration has been in flux, so writing setup documentation hasn't really been feasible up to this point. However, as we converge on a distribution-ready solution we should consider how we will present unified setup/installation instructions. Some things to keep in mind.

  • Rather than storing large data files in the TRegGA distribution, we can rely on scripts like xgetseq and xentret to download and process the data in an automated fashion.
  • I've stored the 3kRGP metadata files (in the reads directory) as compressed files to reduce the code distribution's footprint, but these would need to be decompressed (either manually or by script/makefile) before they could be used (unless we want to simply update the code to read the gzipped data).

We need to collect these and similar setup tasks, determine how much we want to automate, and then provide unified concise instructions for doing so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant