Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disambiguate data get [dataset] and data get from Datafile #19

Open
btc opened this issue Feb 8, 2014 · 2 comments
Open

Disambiguate data get [dataset] and data get from Datafile #19

btc opened this issue Feb 8, 2014 · 2 comments
Labels

Comments

@btc
Copy link
Collaborator

btc commented Feb 8, 2014

@jbenet,

What are your thoughts on disambiguating (1) fetching a single dataset from (2) fetching a collection from a Datafile? Is this something you've already considered and made a decision to avoid?

Proposing the following api modification:

$ data install
# downloads datasets given Datafile

This would pave the way for users to explicitly specify a Datafile without excessively overloading the get command.

$ data install [-arg to specify datafile] Datafile.staging
@btc btc added the question label Feb 8, 2014
@jbenet
Copy link
Owner

jbenet commented Feb 9, 2014

Yeah, data install is similar to what people expect from other package managers.

Have considered (but not settled on what the right approach is):

  • adding data install for dependencies (as you propose)
  • keep them the same, but rename data get to data install
  • use a flag, like data get --deps or data install --deps
  • use a datafile arg, like data get Datafile or data install Datafile
  • use a datafile arg w. flag, like data get --deps Datafile or data install --deps Datafile

It might make sense to differentiate data get and data install as you propose, but semantically get and install are not that obviously different. Is there a more obvious phrasing for the "install dependencies listed in the Datafile" idea? Let's keep in mind that target users are not all software engineers, but scientists in other fields that write programs. In my view, intuitive naming >> traditional naming. Thoughts?

Affects #20.

@btc
Copy link
Collaborator Author

btc commented Feb 9, 2014

This sort of data management is somewhat unprecedented. People install programs and install software, but they download and get data. People don't typically say they're installing data.

On the other hand, data is the first of its kind. There is an opportunity to set the tone and define the new norm. Perhaps data installation is a thing.

Perhaps the tool should ease adoption for new users with something sensible, but ultimately take an authoritative stance.

It's unclear to me. I don't mean to distract you with this non-critical concern. Perhaps this is just something to keep an eye on as the API matures.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants