ropensci-archive / reproducibility-guide Goto Github PK
View Code? Open in Web Editor NEW:no_entry: ARCHIVED :no_entry:
Home Page: http://ropensci.github.io/reproducibility-guide/
:no_entry: ARCHIVED :no_entry:
Home Page: http://ropensci.github.io/reproducibility-guide/
The workflow section needs work, but take the most time to contribute to. It is also in my opinion one of the coolest sections! How to contribute:
http://ropensci.github.io/reproducibility-guide/sections/tools/
para 1: lose the extraneous 'to'
“All the tools listed to here are free,” should read:
“All the tools listed here are free. “
is it 'Markdown' or 'markdown'? should be consistent.
“a list of applications that provide support for authoring in Markdown”
“including a basic tutorial on markdown”
is it 'html' or 'HTML'? should be consistent.
“html in current release, additional formats in preview release”
“An R Markdown document can also be converted to standalone HTML file”
None of the links are hyperlinked . You may need to do
instead of simply putting http://recomputation.org/
Just saw http://www.gitbook.io/
Looks super simple, and you can make it work with just a few changes I think. ALthough this would be a departure from Jekyll I guess, not sure if you'd want to do that.
Links to Gentzkow and Shapiro' writing code manuals are broken. The proper one is http://web.stanford.edu/~gentzkow/research/CodeAndData.pdf . As Gentzkow wrote, '[it] includes material previously circulated as "Notes for RAs on Writing Code"'
Currently the site is building the links with the blog style permalinks and is also ordering those in a manner that I can't seem to figure out.
Any thoughts on how to change the ordering (i.e [here (http://ropensci.github.io/reproducibility-guide/)) of the links? Should we override the permalinks with shorter, less bloggy links? I don't have a lot of experience with Jekyll, but I think we can specifiy the specific link with the YAML on each page.
👋 @iamciera! Thanks a lot for your work on this. As the guide isn't updated we'll archive it... unless you decide otherwise. 😁 We can also transfer it to your personal account. If you don't answer within one week we'll archive it but you could still email us to request we unarchive it. Thank you!
I like the idea that this site is a curation of information where one function is the uniting of existing material. If you guys have excellent references pertaining to a particular section, even if they are in the References section, we should highlight them in the sections. Maybe in a resources section on each page. We should keep them to only the best though, so not to overwhelm. Feel free to add as you please.
It would be nice to have the workflows easily generated so in the future people can add their own, ideally with all of them matching in format and color coding. I can generate them fast in Illustrator, but this would not help long term.
Another will be collecting the workflows.
I do not like how the sections align on top of each other in response to smaller windows. I haven't had time to figure out how to change this. If someone is very familiar with Bootstrap/CSS/HTML this could be a good way to help. I was thinking just have the section "buttons" get smaller, but still remaining in two rows. This will become a bigger issue if more topics are added.
As the first thing anyone reads, the "About" text on the index page should consist of well-edited paragraphs.
Some issues:
This guide is getting pretty rusty. We should really think about what the function of it is. It has a lot of useful information, but I feel like the information is hard absorb. There are too many sections, uneven content, and outdated information.
The first question is, in the condition the site is in now, does it serve a valuable function? And/Or does it do any harm staying up in the condition it is in?
If we decide to keep it going, we should figure out how to make the site better. What do we need to change? What can stay? Organization? Ect?
One idea: Reproducibility is such a malleable topic and there are no real hard rules, making the creation of a good guide extremely difficult. I really like the questions section. Maybe we could put that on the front page and link content/references to learn more along those specific questions. Reproducibility is such a dry topic, I like the idea the front page having useful information that can be quickly digestible. Then give the audience the ability to look deeper with a few highlighted references.
Also, I really like the introduction.
Any thoughts?
Would be easier for folks to navigate I think if workflows were more obviously separated from one another, and perhaps some sort of navigation bar for the different workflows on that page, esp needed as there are more workflows put there.
Are the files in the _site/
directory of any use at all? From what I can see, the website text content, for example, is generated from sections/
. _site/
is in .gitignore
. Perhaps the directory should be just deleted.
I just wanted to have a place where people can put ideas if they want for styling of the site.
@karthik suggested a theme from http://www.blacktie.co/ and they do look really nice AND it would be easy to incorporate.
I think I will deal with this after the official Hackathon so I can get a super clear picture of the content we need to display, but any thoughts are welcome.
What do you guys think about the collaborators section by the made possible by header on main page? I always enjoy learning about the people behind projects, even if it is just a some names and hyperlinks. If we encourage people to add their name when they contribute, it would likely promote collaboration. But then again, seems a little self promoting?
What do you guys think?
After the instruction 'You'll now have a local copy of your version of that repository called "origin"', do you think we should add 'you'll need to change directory in git bash to be working in the new directory that is the local copy'. I think I've been stuck with cryptic error messages at this point a few times. What do you reckon?
Would be nice to have some introductory materials/pre-amble to the guide that explains what the guide is and isn't.
Along those lines a working definition of reproducibility might be nice. Looking back at hackathon issue #22 suggest that there is at least a gradient of reproducibility. Much of our discussion (or at least my recollection of it) has centered around producing reproducible documents, but as many have indicated, reproducibility is a much larger issue than that.
At a simple level as long as one has access to code/data/paper it could meet some minimum criteria of reproducibility. The discussions on data archiving #21 and sustainability/versioning #19 bring up bigger issues that, if dealt with, would make a given piece of work a greater degree of reproducibility. Lastly, @mfenner made the good point that to be fully reproducible automation needs to be considered.
I have done a (very) little work with Linked Open Data and as I have laid it out here it reminds me of the 5 star system of Linked Open Data. Would it be useful to think of reproducibility in the same terms? Is that out of scope for this guide (quite possibly).
In any event, I would find it useful if we could develop an introduction and specific definition about what type/level/etc of reproducibility we are referring to. Will help focus the rest of the guide, I think.
Another resource worth listing: https://github.com/kbroman/Tools4RR
@kbroman does fantastic things in this space and you guys should ask him to do a little review at some point.
After I moved the 2014...Introduction-to-Tools.md content from _posts to to introduction folder, I was sent an email that jekyll is not able to build the site. It works on my computer though. Not sure what is going on.
"... greater efficiency that simply ..." should be "... greater efficiency than simply ..."
"How can software tools can make ..." should be "How can software tools make ..."
Few spots this has come up. Metadata is one word...
After Github switched to a different Jekyll we get page build problems:
You are currently using the 'redcarpet' Markdown engine, which is no longer supported by GitHub Pages and may cease working at any time. To ensure your site continues to build, remove the 'markdown' setting in your site's '_config.yml' file and confirm your site renders as expected. For more information, see https://help.github.com/articles/updating-your-markdown-processor-to-kramdown.
This needs to be fixed.
First Cut at an outline for orgnaizing/navigating the site. I am not wed to any of this. I just like lists!
I just want to mention I am aware that the grey background really isn't working for readability. I am thinking of making the title of the section in a grey container and the body will be white. Any other suggestions?
Currently there are no widely accepted methods of conveniently telling people that your work is reproducible, or where it is on the spectrum of reproducibility. We might consider supporting one of the proposed standards and promoting use of tags, labels or badges to simplify communication of reproducibility and promote the practice in general.
Here are a few standards that have emerged so far:
Victoria Stodden also suggests these categories:
Randy Leveque http://icerm.brown.edu/html/programs/topical/tw12_5_rcem/icerm_report.pdf
Open Science Framework & the journal Psychological Science have attractive badges that could be useful: http://centerforopenscience.org/journals/ http://www.psychologicalscience.org/index.php/publications/observer/2013/november-13/whats-new-at-psychological-science.html
Few spots this has come up. Metadata is one word...
For some reason I could not get the baseurl for the posts to work correctly. So I cheated and added the projects name at all the links with the liquid tags {{ base.url }} should be. Can anyone help?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.