cfmmoc / cfmmoc Goto Github PK

This is Richard Barnes, Associate Editor of Computers & Geosciences.

I've noticed that your source code has almost no comments.

This makes it difficult for other researchers to use or modify your code.

Please add sufficient comments for outside users unfamiliar with your code to discover the purpose of its various parts and understand the rationale behind the various decisions made in the code.

This is roughly the level of commenting I expect to see with code: https://github.com/r-barnes/BarnesClark2017-Salamanders/blob/master/src/phylo.cpp

This is Richard Barnes, Associate Editor of Computers & Geosciences.

Running Make in the obj directory leads to the following error:

cp ../bin/libRQTS.so .
cp: cannot stat '../bin/libRQTS.so': No such file or directory
Makefile:32: recipe for target 'b.so' failed

It looks as though the make process expects a pre-compiled libRQTS.so in the bin/ directory. Your code must not rely on pre-compiled libraries included with the source, as these are not likely to be portable across systems. Rather, your makefile should include directives for compiling the needed libraries or your README should clearly describe how to acquire said libraries.

If you believe a library may cease to be available in the future, including its source with your project is permissible.

Please resolve the foregoing.

This is Richard Barnes, Associate Editor of Computers & Geosciences.

None of the items in the bin/ directory (no pre-compiled code) should be part of the repo.

libpocofoundation48 is added in artful repo after 17.10, so ubuntu 17.4/16.04 will not build correctly!

This is Richard Barnes, Associate Editor of Computers & Geosciences.

Including the makefile inside the obj/ directory is highly non-standard. It is more usual to have the makefile outside the obj/ directory and to run, e.g.,

mkdir obj
cd obj
make -f ../Makefile

Please read up on the appropriate use of makefiles or exam other projects and modify accordingly.