search

pepkit / looper

A job submitter for Portable Encapsulated Projects
http://looper.databio.org
BSD 2-Clause "Simplified" License
20 stars 7 forks source link

Imprecise looper documentation for getting started #488

Closed kripkd closed 3 weeks ago

kripkd commented 2 months ago

I found the documentation for running an example on looper https://pep.databio.org/looper/code/hello-world/ misleading.

Step 2 instructs one to download and unzip hello_looper repository, after which step 3 calls to "Run it by changing to the directory and then invoking looper run on the project configuration file." This instruction is imprecise, and I interpreted it as an instruction to change into the newly unzipped directory hello_looper-master. However, the only thing that worked was running looper from a directory in which hello_looper-master is located.

It is also not immediately clear why yaml files are dotfiles as it complicates the troubleshooting and is inconsistent with other software like refgenie and bulker.

I would suggest changing the documentation to make the instructions on the test run clearer.

donaldcampbelljr commented 4 weeks ago

Thank you for flagging this. The issue should be solved with the upcoming 1.8.1 release and along with it updates to the official documentation: https://github.com/pepkit/pepspec/pull/32

donaldcampbelljr commented 3 weeks ago

Closing due to v1.8.1 release.