iangow / se_features

Linguistic features derived from StreetEvents
1 stars 3 forks source link

Document code in liwc_etc #1

Closed iangow closed 5 years ago

iangow commented 6 years ago

@danielacarrasco:

Code in liwc_etc provides a template of sorts.

For example, liwc_run.py calls liwc_add.py which uses functions in liwc_functions.py. I think it would make sense to add a little documentation explaining what the various pieces of code do (at a high level). This will make it easier to apply the "template" to calculating other features. Documentation would be quite short and basic (probably a README.md file in the liwc_etc directory.

iangow commented 5 years ago

@danielacarrasco it may be that this is already done. If the readme is correct and sufficiently describes the way the code runs, then I think we can close this issue. One thing that I noticed is a reference to liwc_tmp. This may be incorrect and require a simple fix to the readme.

danielacarrasco commented 5 years ago

yes, you are right. I just corrected it.

danielacarrasco commented 5 years ago

I'll read the README again and make sure it's all okay. I'll be closing it afterwards (probably tomorrow).

danielacarrasco commented 5 years ago

I'll read the README again and make sure it's all okay. I'll be closing it afterwards (probably tomorrow).

It all looks good so I'll close this.