search

MetabolicAtlas / data-generation

Process the raw data-files for ingestion into the Neo4j database
MIT License
0 stars 0 forks source link

docs: update Readme #10

Closed nanjiangshu closed 3 years ago

nanjiangshu commented 3 years ago

Clarify which yarn to use and the usage of command.

nanjiangshu commented 3 years ago

I actually don't understand what the command $ yarn (without the flag "start <data-file-path") is doing. It it does not generate any real data, then we should remove it.

e0 commented 3 years ago

@nanjiangshu Thanks for the PR. The yarn command is short for yarn install. It install the NPM packages under node_modules.

nanjiangshu commented 3 years ago

Thanks @e0 for clarification! So there are two steps,

The command $ yarn installs NPM packages and then $ yarn start <path-of-data-file> generates data.

e0 commented 3 years ago

So there are two steps

That's exactly right, we were way too sloppy on the documentation before.

mihai-sysbio commented 3 years ago

As suggested by @e0 it would be good to add the minimum versions required too.

nanjiangshu commented 3 years ago

This Readme assumed a lot of prior knowledge, so it's really good to address this. Let's also clarify that while these commands can be run on their own, the output is meaningful only for the deployment pipeline. Here is the documentation for the yarn command. It would be good to have this in the Readme too.

This comment is addressed.