Giter Site home page Giter Site logo

Comments (6)

yarikoptic avatar yarikoptic commented on July 25, 2024

Yes

But I think it is ok to state original domain/purpose

from datalad-paper-joss.

yarikoptic avatar yarikoptic commented on July 25, 2024

We can should add explicit statement on fields of science where we know it has been used already: neuroscience, physics, machine learning, bioinformatics ideally with references to example papers or datasets

from datalad-paper-joss.

adswa avatar adswa commented on July 25, 2024

Suggestion:

Instead of

The simplest "prototypical" example is datalad search haxby which would install the http://datasets.datalad.org superdataset, and search for datasets mentioning haxby anywhere in their metadata records. Any reported dataset could be immediately installed using datalad install command, and data files of interest obtained using datalad get.

Should we simply refer to the handbook usecases and the asci casts on the datalad website for prototypical examples from a few fields? I think this is @yarikoptic's simplest prototypical usecase and people that are unfamiliar with Haxby or the data he has published will be confused :P It also puts a bit of a focus on datalad search, which is not even documented in the handbook and may backfire if anyone want to read up on this "prototypical example"

from datalad-paper-joss.

yarikoptic avatar yarikoptic commented on July 25, 2024

I think we should have some specific example in the manuscript to not only address reviewer checklist item

Example usage: Do the authors include examples of how to use the software
(ideally to solve real-world analysis problems).

but also to give some "ready to use" command any reader could try right away without going anywhere else. And then we definitely should add a reference to the handbook.

... people that are unfamiliar with Haxby or the data he has published ...

We could clarify :

The simplest "prototypical" example is datalad search haxby which would install the http://datasets.datalad.org superdataset, and search for datasets mentioning haxby --a prominent neuroscientist who supported and facilitated DataLad birth-- anywhere in their metadata records.

In either case we should also add Jim to acknowledgement section: #17

It also puts a bit of a focus on datalad search, which is not even documented in the handbook and may backfire if anyone want to read up on this "prototypical example"

Well, I think it is a shortcoming of the handbook, should be addressed there (datalad-handbook/book#324 and I am not even an author), and although can contribute to decision making of replacing datalad search with some other exemplar command here, should not be the only factor. Meanwhile we can add a reference to http://docs.datalad.org/en/stable/generated/man/datalad-search.html to accompany that example command, which might be of benefit as well since we do not link much into docs.datalad.org.

from datalad-paper-joss.

yarikoptic avatar yarikoptic commented on July 25, 2024

Should we simply refer to the handbook usecases and the asci casts on the datalad website for prototypical examples from a few fields?

We should definitely point to handbook usecases, will send a PR now. ascinema casts on website -- nah, should be gone, apparently there is no issue so filed a new one datalad/datalad.org#75

from datalad-paper-joss.

yarikoptic avatar yarikoptic commented on July 25, 2024

agreement for focus was "No". Unfortunately there is not that many examples of use to demonstrate for other fields ATM though.

from datalad-paper-joss.

Related Issues (20)

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.