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

infographic for principles? #119

Open
danielskatz opened this issue Apr 17, 2016 · 52 comments
Open

infographic for principles? #119

danielskatz opened this issue Apr 17, 2016 · 52 comments

Comments

@danielskatz
Copy link
Contributor

danielskatz commented Apr 17, 2016

Should we create a graphic of some type that makes this more appealing to a wider audience?

perhaps in addition, create a few (3?) slides that people can use to talk about this.

@BruceCaron
Copy link

Great Idea... happy to help.

@kyleniemeyer
Copy link
Collaborator

Suggestion from @ljhwang: create few slides for "Software Citation Evangelists"

@ljhwang
Copy link
Contributor

ljhwang commented Apr 17, 2016

I'll help

@maltman
Copy link
Contributor

maltman commented Apr 17, 2016

Important to have one slide visualizing a citation example, and connecting to principle. Consider 2nd slide from data citation principles deck.
https://www.force11.org/node/4771

@wakibbe
Copy link

wakibbe commented Apr 17, 2016

I would be happy to participate. I have seen a nice graphic from the Force11 community highlighting the full ecosystem of data, annotation, analysis, knowledge extraction around a research project, and visually showing where software citation is coupled into that ecosystem would be very helpful for people to frame software citation.

@espacial
Copy link

I can take care of preparing a simple draft (and we can iterate from there)

@ljhwang
Copy link
Contributor

ljhwang commented Apr 17, 2016

Great! i am happy to help too!!

Best,
-Lorraine


Lorraine Hwang, Ph.D.
Associate Director, CIG
530.752.3656

On Apr 17, 2016, at 10:05 AM, Laura Rueda [email protected] wrote:

I can take care of preparing a simple draft (and we can iterate from there)


You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub #119 (comment)

@ScottBGI
Copy link
Contributor

As a suggestion, like the style of infographic that @michaelbarton did for Bioboxes bioboxes/rfc#87 (comment)

@jmcmurry
Copy link

jmcmurry commented Apr 17, 2016

@ScottBGI +1; That's very nice. Also happy to help with graphic.

@ljhwang
Copy link
Contributor

ljhwang commented Apr 17, 2016

like the basic concepts (but with more color!), we probably could use something like the top half.

Best,
-Lorraine


Lorraine Hwang, Ph.D.
Associate Director, CIG
530.752.3656

On Apr 17, 2016, at 10:11 AM, Julie McMurry [email protected] wrote:

@ScottBGI https://github.com/ScottBGI +1; That's very nice


You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub #119 (comment)

@jmcmurry
Copy link

This is the figure I made for the RRID tech spec poster. I can adapt for this purpose...
screen shot 2016-04-17 at 12 19 02 pm

@Daniel-Mietchen
Copy link
Contributor

I'm happy to participate here as well.

@ljhwang
Copy link
Contributor

ljhwang commented Apr 21, 2016

Considering our audience will come from a wide background in both familiarity with software citation and scientific domain, perhaps we should frame this in terms of the 4 W's (definitely not wedded to this scheme but for discussion sake):

  • Why? The Case for Software Citation this would state the needs
  • What? The Software Citation Principles
  • Who? The Stakeholders why you should care
  • Where? More Information About FORCE11 and how to become involved

The 2nd challenge is the graphic. Did the Data Citation Group do one? I am thinking it would be good to have a consistent look across the working groups.

For those wishing to work on this, perhaps we move this off to a shared document. Suggestions?

@jmcmurry
Copy link

jmcmurry commented Apr 21, 2016

Before we move to a shared document, let's perhaps refine what graphics is we are aiming to do. It sounds like there are at least 3.

    1. ecosystem

" I have seen a nice graphic from the Force11 community highlighting the full ecosystem of data, annotation, analysis, knowledge extraction around a research project, and visually showing where software citation is coupled into that ecosystem would be very helpful for people to frame software citation." - @wakibbe can you point us to this graphic?

    1. anatomy of an example software citation connected to principles

"Important to have one slide visualizing a citation example, and connecting to principle. Consider 2nd slide from data citation principles deck. https://www.force11.org/node/4771"

    1. who, what, why, where

Which of these is the top priority to tackle? Perhaps lets start with consensus on this question and then move to a shared doc. (I recommend svg in this repository as this is the most interconvertible and least annoying format).

@ljhwang
Copy link
Contributor

ljhwang commented Apr 21, 2016

is the second bullet out of scope? e.g. the Citation implementation group?

@danielskatz
Copy link
Contributor Author

I'm pinging here to raise this issue back up...

We now have the final version of the document complete (as in this repo in tex, or in https://peerj.com/preprints/2169/ as text, and to be published in PeerJ Computer Science and the FORCE11 web site).

So it's time to come back to creating a few slides and an infographic, then this group will have done all its work and can end, with an implementation group hopefully coming next.

Does anyone want to take the lead on the infographic and slides?

@arfon
Copy link
Contributor

arfon commented Sep 21, 2016

@mfenner - I just saw this post in on the DataCite blog https://blog.datacite.org/software-citation-principles/ with a very nice looking infographic.

@espacial - it looks like this was created by you. Can you confirm the license for the graphic and whether we can re-use it? (If so, we should add a credit to the graphic and the license).

@mfenner
Copy link

mfenner commented Sep 21, 2016

Yes, the infographic was created by @espacial.

@espacial
Copy link

@arfon Please credit freepik.com if you want to reuse this one, it's loosely based on one of their templates.

I already offered myself to prepare a 'proper' one but I missed @danielskatz's request last month (holidays!). I'll prepare an original piece we can reuse freely, give me until tomorrow ;)

@arfon
Copy link
Contributor

arfon commented Sep 21, 2016

I already offered myself to prepare a 'proper' one but I missed @danielskatz's request last month (holidays!). I'll prepare an original piece we can reuse freely, give me until tomorrow ;)

If that's OK that would be great!

@ljhwang
Copy link
Contributor

ljhwang commented Sep 21, 2016

This looks great. Thanks @espacial https://github.com/espacial for creating. Is it possible to tweak some of the icons? I like the Credit, Persistence and Accessibility ones but the others I do not either get the connection to or object to.

Best,
-Lorraine


Lorraine Hwang, Ph.D.
Associate Director, CIG
530.752.3656

On Sep 21, 2016, at 7:55 AM, Arfon Smith [email protected] wrote:

I already offered myself to prepare a 'proper' one but I missed @danielskatz https://github.com/danielskatz's request last month (holidays!). I'll prepare an original piece we can reuse freely, give me until tomorrow ;)

If that's OK that would be great!


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub #119 (comment), or mute the thread https://github.com/notifications/unsubscribe-auth/AESQXySaaRu6fS7C_3kUNL5strOfQyTCks5qsUV-gaJpZM4IJNJo.

@espacial
Copy link

What about this one?
image

@danielskatz
Copy link
Contributor Author

In general, I like the aspect of the first one that makes all principles seem equally important a bit better than this one, where it seems like there are chains of principles further and further from the center.

On the other hand, I like the style (color, graphics, etc.) of this one better.

@danielskatz
Copy link
Contributor Author

Also, I wonder if the names of the principles could be a bit larger?

@kyleniemeyer
Copy link
Collaborator

kyleniemeyer commented Sep 22, 2016

+1 both of @danielskatz's comments. For a single infographic that depicts the principles, some combination of the two seems great.

@ljhwang
Copy link
Contributor

ljhwang commented Sep 23, 2016

ditto here on dan’s comments

I like the use of the “!” for importance in the 2nd one as well.

Best,
-Lorraine


Lorraine Hwang, Ph.D.
Associate Director, CIG
530.752.3656

On Sep 22, 2016, at 11:07 AM, Kyle Niemeyer [email protected] wrote:

I +1 both of @danielskatz https://github.com/danielskatz's comments. For a single infographic that depicts the principles, some combination of the two seems great.


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub #119 (comment), or mute the thread https://github.com/notifications/unsubscribe-auth/AESQX72ffd2LEzVKWy6RYFKTGCXbwdUtks5qssPxgaJpZM4IJNJo.

@danielskatz
Copy link
Contributor Author

Hi @espacial - I hate to bug you on something you are doing as a volunteer, but what's happened with this?

@ljhwang
Copy link
Contributor

ljhwang commented Oct 14, 2016

Hi,

How about a “target” instead of a scope sight for specificity? (

Other thoughts:
making the arms more balanced/equal in length
uniformly putting the words inside (or outside) the arms

I have a graphic artist here who can help make adjustments if necessary. I would need a clean copy (best resolution possible) for her to work with.

Best,
-Lorraine


Lorraine Hwang, Ph.D.
Associate Director, CIG
530.752.3656

On Oct 14, 2016, at 11:38 AM, Daniel S. Katz [email protected] wrote:

Hi @espacial https://github.com/espacial - I hate to bug you on something you are doing as a volunteer, but what's happened with this?


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub #119 (comment), or mute the thread https://github.com/notifications/unsubscribe-auth/AESQX9EOoF4xLzXr4mRDl4wYxPc4XgHbks5qz8wjgaJpZM4IJNJo.

@danielskatz
Copy link
Contributor Author

danielskatz commented Jan 23, 2017

Here is a new draft from @espacial
comments are welcome

three.pdf
three

@ljhwang
Copy link
Contributor

ljhwang commented Jan 23, 2017 via email

@danielskatz
Copy link
Contributor Author

@espacial can easily make non-gray versions, I believe.

I agree that removing the extra dots is a good idea.

Going back to the original from the DataCite blog, I do like the framing, with "software is a critical part of modern research ..." at the top and "... yet there is little support for its acknowledgement and citation" at the bottom.

changing the arrow to a pointer seems ok.

I'm ok with the font size.

@mhucka
Copy link
Contributor

mhucka commented Jan 23, 2017

2nd'ing Lorraine's points.

Random other comments & suggestions:

  • I am unclear about what "They should be included in the metadata of the citing work" means under "Importance".
  • Under "Specificity", the first sentence ends with "the specific version of software that was used", which should maybe be slightly more specific. Perhaps "used in the research" or "... used to produce a result" or something along those lines?
  • The grammatical structure of the text under "Credit and attribution" is awkward enough that I found myself re-reading trying to figure out what it said. That one could use a little bit of editing!

Finally, I echo Lorraine's points about the size of the font. In terms of graphic design, it seems rather small compared to the overall size of the figure and the available space. Perhaps it could be increased just a little? Doesn't have to be made huge, but it looks like it could easily be made a little larger.

Thanks to everyone who's working on this!

@danielskatz
Copy link
Contributor Author

Specificity and credit&attribution use exactly the same language as in the principles in the paper, which I do not want to change at this point.

For Importance, the Principle in the paper is
"Software should be considered a legitimate and citable product of research. Software citations should be accorded the same importance in the scholarly record as citations of other research products, such as publications and data; they should be included in the metadata of the citing work, for example in the reference list of a journal article, and should not be omitted or separated. Software should be cited on the same basis as any other research product such as a paper or a book, that is, authors should cite the appropriate set of software products just as they cite the appropriate set of papers."

If you have a suggestion for a better short version of this than what is in the graphic, please put it here.

@ljhwang
Copy link
Contributor

ljhwang commented Jan 23, 2017 via email

@mhucka
Copy link
Contributor

mhucka commented Jan 24, 2017

Ah, okay, so "metadata" in this context is (e.g.) the references in a paper. I guess I didn't notice this use of "metadata" in the paper (my fault, obviously). I must say it feels strange to call the reference list "metadata" – it seems more like part of the paper's content to me, and not "data about the paper" as the term metadata would imply. But okay, that's fine, you folks no doubt already hashed this out.

So the question is how to prevent readers like me from going down the wrong path when they read that sentence in the poster, and do it with as few words as possible. What about a parenthetical clarification like this:

included in the metadata (e.g., reference list) of the citing work

?

@danielskatz
Copy link
Contributor Author

If it helps, you can think of registering a new piece of software as a product, the references for that software would be metadata.

I think your suggestion is good, however. A new set of text for Importance would then be:

Software should be considered a legitimate and citable product of research. Software citations should be accorded the same importance in the scholarly record as citations of other research products; they should be included in the metadata of the citing work, such as a reference list. Software should be cited on the same basis as any other research product such as a paper or a book.

@timclark
Copy link

timclark commented Jan 24, 2017 via email

@ljhwang
Copy link
Contributor

ljhwang commented Jan 25, 2017 via email

@danielskatz
Copy link
Contributor Author

danielskatz commented Feb 13, 2017

Here are two new versions (white and black backgrounds) from @espacial - I'm hopeful these are the last versions for now, but let us know

four_white.pdf
four.pdf
four
four_white

@ljhwang
Copy link
Contributor

ljhwang commented Feb 13, 2017 via email

@kyleniemeyer
Copy link
Collaborator

@danielskatz I like it! My only thought—and this is just putting an idea out there—is whether we want a version of that just with the image/icons and principle titles. Meaning, the above infographic without the body text associated with each principle.

I'm mainly thinking about this in the context of a presentation or talk, where small text would detract from the message.

@danielskatz
Copy link
Contributor Author

I don't think we need that at this point. This is intended to be a larger, stand-alone graphic.

Although a standard set of slides that build on this would also potentially be useful (though separate.)

@ljhwang
Copy link
Contributor

ljhwang commented Feb 13, 2017 via email

@kyleniemeyer
Copy link
Collaborator

@danielskatz @ljhwang yeah, we don't need an additional image, but perhaps just the source for the above images? Again, this is pretty minor—I think the above two are great as an infographic.

@danielskatz
Copy link
Contributor Author

ok, I will ask @espacial for the source (probably Illustrator)

@iliant
Copy link
Contributor

iliant commented Feb 13, 2017 via email

@espacial
Copy link

Hi everybody,

Both PDFs are 'sources' (editable PDFs) but if you want a different format (AI, SVG... ) I would be more than happy to export them. Same for the variations (with or without text, individual pieces... ). Daniel knows it's kind of painful to contact me, but it ends up happening 🙄

@iliant Let's make the image CC0!

@danielskatz
Copy link
Contributor Author

I'm adding versions of this in https://github.com/force11/force11-scwg/tree/master/infographic

@danielskatz
Copy link
Contributor Author

Thanks very much @espacial - I'm going to declare this done and close this in a week or so if there are no more comments

@ljhwang
Copy link
Contributor

ljhwang commented Feb 14, 2017 via email

@danielskatz
Copy link
Contributor Author

danielskatz commented Feb 14, 2017 via email

@danielskatz
Copy link
Contributor Author

I've added a gear icon now

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

No branches or pull requests