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

Not clear what is what. Repo needs a readme and some guidance. Where are the data files? I do not see any csv files? #1

Open
grunwald opened this issue Feb 18, 2020 · 6 comments

Comments

@grunwald
Copy link
Member

No description provided.

@grunwald grunwald changed the title Not clear what is waht. Repo needs a readme and some guidance. Where are the data files? Id o not see any csv files? Not clear what is what. Repo needs a readme and some guidance. Where are the data files? I do not see any csv files? Feb 18, 2020
@Neato-Nick
Copy link
Collaborator

Everything is in the R data files (.Rd). Since I did all the analysis in R, I figured if anyone wanted to reproduce the work they'd be doing it in R. They can just load the .Rd and all the variables will load in.

I can write a readme that explains this

@grunwald
Copy link
Member Author

Yes, if things are not clear to me the reviewers will be even more lost. Thanks. Are the Rmd files annotated enough with comments so that a reader knows what is done where? Also think the figures can be removed.

@Neato-Nick
Copy link
Collaborator

8d97a1c

@Neato-Nick
Copy link
Collaborator

There's not much annotation, just a header (e.g. "### Figure 1") for each section where I made a figure.

The idea is to just be able to reproduce the figs. I spent a lot more time annotating and commenting my code for a previous pub, and not a single commenter or reviewer said anything.

@grunwald
Copy link
Member Author

Your point is a good one, but chicken and egg. Would you have gotten comments if it were not annotated? I am not a fan of excessive annotation, but just short headers that tell what is what ...
I agree there is no need for a lot of comments. but it needs to be clear what was done. If a figure is clearly identified then readers can look at the text and know what was done.

@Neato-Nick
Copy link
Collaborator

Would you have gotten comments if it were not annotated?

Also a good point. I'll add a bit more to the Rmd but avoid adding a deluge.

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

No branches or pull requests

2 participants