search

chicago-police-violence / data

Dataset about the personnel, use of force, and complaints in the Chicago Police Department
MIT License
7 stars 0 forks source link

Create an example/ folder including, for example, a script to generate the network #6

Open trevorcampbell opened 3 years ago

trevorcampbell commented 3 years ago

Perhaps in an examples/ folder illustrating how the data can be used?

Thibauth commented 3 years ago

I completely agree. I actually have exactly such a script (it is super short) and I think it fit nicely in an example folder. I don't think we need to include the output (the network itself) if we have a simple script to generate it (it only takes a few seconds to run and has no dependency).

In the long run, I envision that this example folder could even contain things like benchmarking community detection algorithms, etc.

trevorcampbell commented 3 years ago

Yup -- I am a big fan of storing only the code required to generate results, not the results themselves!

(the only exemption here is for documentation -- I think we should include main.pdf once we're done and settled with it, per #2)