Code Monkey home page Code Monkey logo

boutiques-tutorial's Introduction

NeuroLibre

Build Status

This is the website of NeuroLibre, a preprint service for interactive data analysis in neuroscience. The site is rendered at neurolibre.org. You can also check out the NeuroLibre docs.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

⚙️ Development

LiveReload enables the browser to automatically refresh on change during development.

  1. Download the LiveReload Chrome plugin
  2. Run bundle exec guard

boutiques-tutorial's People

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar

boutiques-tutorial's Issues

Validation and checking of the descriptor with zenodo ID

In Step 4 and 5 the validation and checking of the descriptor is shown using the zenodo ID (not the JSON file). However, if the tutorial is followed in order and I understood it correctly, by these steps we have not created a zenodo ID of our tool yet. Is there a reason why you didn't choose to demonstrate how the validation and checking works running bosh validate fsl-bet-final.json? Perhaps this is more consistent with the logical order of the tutorial.

Bash commands knowledge

The tutorial assumes familiarity with bash commands (e.g. commands like cat and grep are used but their purpose is not explained). Perhaps it would be nice to anticipate such background to the reader at the very beginning of the tutorial (and even link to some helpful tutorials like you did with JSON), or explain in more detail what these commands are doing when using them (e.g. add a sentence saying 'now we are going to display the contents of our edited JSON file' when using cat).

Networking issues

We are having problems with the computecanada bandwidth, the building takes longer than usual.

Sorry for the inconvenient,

Python API knowledge

Similar to this issue #11 - there are a few places where it's unclear what the expected level of familiarity with Python APIs is. It would be helpful to the reader if this expectation were clarified at the top of the notebook or if more verbose explanations were given throughout the notebook.

For instance, the user is shown how to use the bosh example command both on the command line and with the API. Instead of saying "Of course, this can all be reproduced with the Python API, for instance", there could be an explanation about arguments having to be passed in the same order on the command line as they are when using the Python API.

image

Likewise, it might be helpful to be more verbose when explaining that descriptor2func is a library within the overarching Boutiques module, and it has its own set of commands. The python function created by passing a Zenodo DOI to the command function is the main function corresponding to the tool associated with the DOI .

image

review #2

Thank you @martinagvilas for agreeing to review this submission. You can find our guidelines for review here. When your review is completed, please leave a comment on this issue saying so. If there are unresolved issues that you believe to be impeding the acceptance of the repository, please list them here.

review #1

Thank you @llevitis for agreeing to review this submission. You can find our guidelines for review here. When your review is completed, please leave a comment on this issue saying so. If there are unresolved issues that you believe to be impeding the acceptance of the repository, please list them here.

neurolibre link

Please push on neurolibre and share the link here, so we can share with reviewers

CalledProcessError when running bet -h

Hi! Thanks for submitting this very useful tutorial of boutiques.

Here goes my first issue:

When running the command bet -h in the tutorial I obtain a CalledProcessError. Specifically, I get the following output (after the printout of the command line options of bet):

image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.