search

statgen / pheweb

A tool to build a website to browse hundreds or thousands of GWAS.
MIT License
158 stars 65 forks source link

Notes from test install #110

Closed abought closed 5 years ago

abought commented 5 years ago

Add a file describing local installation and how to create a persistent development, separate from ephemeral test directories.

pjvandehaar commented 5 years ago

Adding this line to ./config.py will avoid downloading dbSNP and gencode:

cache = '/Users/peter/pheweb/tests/input_files/fake-cache'

Is this worth mentioning?

abought commented 5 years ago

Is this worth mentioning?

Overall, yes! Would the fake cache change how the generated plots look / behave? I imagine the "development environment" scenario would be most useful for someone who needed to tweak the UI, with a quick way to get a decent plot for testing purposes.

Anything that could save an hour (!) up front is super useful- we should mention it, even if not as a default recommendation. Maybe a footnote?

I would leave off the absolute path in the example, though- not everyone is /Users/peter. For the most part these instructions call for commands to be run from the cloned repository root, and the goal is for anyone who opens this repo to use the examples and artifacts equally. (see sample file that gave me pause)