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

Initial draft of JOSS paper #394

Merged
merged 17 commits into from
Oct 15, 2018
Merged

Initial draft of JOSS paper #394

merged 17 commits into from
Oct 15, 2018

Conversation

ellisonbg
Copy link
Collaborator

Hi all, here is a draft of a JOSS paper. I would like to submit this to JOSS after the 1.2.1 release comes out. Right now I have listed Jake and I as authors, but if there is anyone else who has contributed that wants to be listed, please post to this issue:

  • That you have read the submission and approve of its content
  • Your name, orcid, affiliation, etc needed for the YAML metadata.

I am still working on getting all the references in place. Also would love ideas for an example image to include.

Fixes #389

@ellisonbg ellisonbg added this to the 1.2.1 milestone Oct 2, 2017
@ellisonbg ellisonbg requested a review from jakevdp October 2, 2017 22:02
@ellisonbg
Copy link
Collaborator Author

@stsievert are you interested in being an author on this JOSS paper with @jakevdp and I? We want to be generous with authorship and you have definitely contributed. If there is anyone else who wants to be an author, please let us know as well. The criteria for authorship is a contribution to Altair and a willingness to review the paper and certify that you have reviewed its content and approve of it.

@stsievert
Copy link
Contributor

@ellisonbg I'd be happy to be an author! And 👍 for publishing – altair is quality software.

My orcid is 0000-0002-4275-3452 and I'm affiliated with University of Wisconsin--Madison. I have read the submission and approve the content.

@ellisonbg
Copy link
Collaborator Author

@stsievert great!

Also wanted to clarify for others. The criteria of authorship is "contribution" - but that doesn't necessarily have to be code/PR/commits. It could also be design, documentation, discussion, etc. Would love to have any others join who have contributed in these ways.

@domoritz
Copy link
Member

Can you add the VL folks who helped with Altair?

- name: Dominik Moritz
   orcid: 0000-0002-3110-1053
   affiliation: 1

@kanitw @jheer, what are your orcids?

@ellisonbg
Copy link
Collaborator Author

ellisonbg commented Oct 17, 2017 via email

@ellisonbg ellisonbg modified the milestones: 1.2.1, 2.0 Oct 17, 2017
@eitanlees
Copy link
Contributor

I have enjoyed creating examples and testing the 2.0 api. I would love to be an author if you think that's appropriate. I have read the submission and approve of its content. My information is

- name: Eitan Lees
   orcid: 0000-0003-0988-6015
   affiliation: Florida State University

@jheer
Copy link
Member

jheer commented Mar 2, 2018

Finally got an Orc ID. Here you go.

- name: Jeffrey Heer
  orcid: 0000-0002-6175-1655
  affiliation: University of Washington

@stsievert
Copy link
Contributor

stsievert commented Mar 2, 2018

Here's my info, reformatted.

- name: Scott Sievert
  orcid: 0000-0002-4275-3452
  affiliation: University of Wisconsin--Madison

@kanitw
Copy link
Member

kanitw commented Mar 3, 2018

Here is mine!

- name: Kanit Wongsuphasawat
  orcid: 0000-0001-7231-279X
  affiliation: University of Washington

@ellisonbg
Copy link
Collaborator Author

Hi everyone, with Altair 2.0 release, I think it would be a good time to finish the JOSS paper. I have rebased on master, and added everyones names, orcid IDs and affiliations that commented above.

A few questions:

  • Author order. When we write Jupyter papers, we list "Jupyter Development Team" as the first author and then list individual alphabetically after that. Jupyter has a huge team so I don't know if that is the right approach here. For now I have listed Jake first, me second, everyone else alphabetically. We could also list in order of commits, but that downplays the often significant non-commit contributions. I am open to different approaches - the important thing is to document in a foot note how we made the choice. Thoughts?
  • Who else. Are there other folks that have contributed during the 2.0 release cycle that should be included?
  • Text/references. There is still a good amount of work to do on the text and reference. Anyone want to work on that?

@eitanlees
Copy link
Contributor

I think @palewire should be included, if he is interested.

@domoritz
Copy link
Member

I think it makes sense to include the top contributors from https://github.com/altair-viz/altair/graphs/contributors. I'm not sure how liberal you want to be with authorship but there probably needs to be some cutoff (e.g. code patches for bugs or features, two non-trivial examples, advising role, ...) so that the list doesn't become too long (and soon outdated).

@domoritz
Copy link
Member

I also suggest @iliatimofeev for his work on bringing geopandas to altair: #818

@palewire
Copy link
Contributor

If you'll have me, I'm happy to join.

- name: Ben Welsh
  orcid: 0000-0002-5200-7269
  affiliation: Los Angeles Times Data Desk

What else can the proposal use? I see a number of things that could a reference or hyperlink. Is there a preferred formatting style for that? If nothing else, a little copy editing?

@ellisonbg
Copy link
Collaborator Author

@palewire yes, happy to have you! I just pushed a commit with the affiliation fixes and your information

@domoritz
Copy link
Member

domoritz commented Aug 8, 2018

I made some updates and sent a PR: ellisonbg#4. What else is left?

@ellisonbg
Copy link
Collaborator Author

ellisonbg commented Aug 8, 2018 via email

@iliatimofeev
Copy link
Contributor

If it still possible I'll be happy to be mentioned

- name:  Ilia Timofeev
  orcid: 0000-0003-1795-943X
  affiliation: TTS Consulting

@domoritz
Copy link
Member

@iliatimofeev, I added you to ellisonbg#4.

paper/paper.md Outdated

The declarative nature of the Vega-Lite visualization grammar, and its encoding in a formal
JSON schema, provide Altair with a number of benefits. First, much of the Altair Python code,
tests, and examples are autogenerated from the Vega-Lite JSON schema, ensuring strict conformance
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove "examples" here, because we no longer auto-generate them

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@domoritz
Copy link
Member

domoritz commented Oct 5, 2018

I made a pass to finish the paper. Check out ellisonbg#5 and let me know if you have any feedback.

@domoritz
Copy link
Member

domoritz commented Oct 8, 2018

Who wants to take care of the submission? Is there something else left to do?

@stsievert
Copy link
Contributor

Is there something else left to do?

I have opened ellisonbg#6, which has a WIP label (tentative implementation, and open for discussion).

@domoritz
Copy link
Member

domoritz commented Oct 8, 2018

Ups, that looks like myistake. Yes, we should credit you as a contributor as per @ellisonbg'e comment.

@stsievert
Copy link
Contributor

Thanks for the comment @domoritz. I've removed the WIP in label from that PR.

@ellisonbg
Copy link
Collaborator Author

ellisonbg commented Oct 11, 2018 via email

@domoritz
Copy link
Member

Can you merge ellisonbg#6?

Revert deletion from author list
@domoritz
Copy link
Member

@ellisonbg Thanks!

@jakevdp @ellisonbg I'm happy to prepare the submission when you squash/merge this PR. The paper has to be in the repo.

@domoritz
Copy link
Member

ping @jakevdp @ellisonbg

@ellisonbg
Copy link
Collaborator Author

I am going to merge, we can always make minor changes later. I don't remember who the person was willing to review the JOSS article, but they were an editor, so they should see it upon submission. Thanks everyone!

@ellisonbg ellisonbg merged commit d82bbc5 into vega:master Oct 15, 2018
@domoritz
Copy link
Member

Thanks. I'll get the submission started.

@domoritz
Copy link
Member

You can follow the progress at https://joss.theoj.org/papers/cd11f880b3f81bf5b5a225007212dc8b

@domoritz
Copy link
Member

Here is the review issue openjournals/joss-reviews#1024

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

Successfully merging this pull request may close these issues.

9 participants