search

Chicago / food-inspections-evaluation

This repository contains the code to generate predictions of critical violations at food establishments in Chicago. It also contains the results of an evaluation of the effectiveness of those predictions.
http://chicago.github.io/food-inspections-evaluation/
Other
410 stars 130 forks source link

Location of technical article? #47

Closed tomschenkjr closed 9 years ago

tomschenkjr commented 9 years ago

This is annoying late in the game, but proposing a conversation on where to place the article in the repo. Right now it's placed in the root. However, there are a number of files/artifacts for this article (as opposed to REPORTS).

.
├── (other files)
├── REPORTS/
├── article
|   ├── forecasting-restaurants-with-critical-violations-in-Chicago.Rmd (Kntir doc)
|   ├── forecasting-restaurants-with-critical-violations-in-Chicago.pdf (PDF)
|   ├── forecasting-restaurants-with-critical-violations-in-Chicago.doc (Word)
|   ├── forecasting-restaurants-with-critical-violations-in-Chicago.html (Webpage)
|   ├── forecasting-restaurants-with-critical-violations-in-Chicago.bib (BibTeX of references)
|   └──  forecasting-restaurants-with-critical-violations-in-Chicago-citation.bib (PROPOSED: BibTeX of citation for what we write)

As you can see, I am pointing-out the inclusion of BibTeX file needed to generate the article's bibliography. I'm also proposing a BibTeX file that shows how to cite the article we have prepared.

Thoughts?

geneorama commented 9 years ago

I think we should ditch the word file and html version and just keep the pdf.

I also think it would be ok to move the .Rmd and .bib file to REPORTS/, and keep the output at the higher level. Maybe we could add a comment to the .Rmd file to point out that we manually moved it up a level?

tomschenkjr commented 9 years ago

Agree on ditching Word version.

Good idea on keeping .Rmd and .bib in REPORTS/ and moving final output at ./. Let's do that. I can adjust it. To be clear for everyone, it would look like:

.
├── (other files)
├── REPORTS/
|   ├── forecasting-restaurants-with-critical-violations-in-Chicago.Rmd (Kntir doc)
|   ├── forecasting-restaurants-with-critical-violations-in-Chicago.bib (BibTeX of references)
|   └──  forecasting-restaurants-with-critical-violations-in-Chicago-citation.bib (PROPOSED: BibTeX of citation for what we write)
├── forecasting-restaurants-with-critical-violations-in-Chicago.pdf (PDF)
└── forecasting-restaurants-with-critical-violations-in-Chicago.html (Webpage)

I'll open a separate branch at iss47 since I will need to adjust the code and test to see if it works. Here are the following tasks:

geneorama commented 9 years ago

I started moving the files, it actually created a few small issues. Namely the path gets messed up because Knitr uses the file's location as . rather than the project root folder.

Also, I noticed that the knitcitations library was in loaded in a call to library rather than the load_install_libraries command from geneorama. I don't know if you want to keep this dependency, but I did need to install the library to compile the knitr doc (and the installation is handled by load_install_libraries).

tomschenkjr commented 9 years ago

Go ahead and make a switch on that. I’m not sure what that function was doing.

From: Gene Leynes [mailto:notifications@github.com] Sent: Tuesday, February 10, 2015 4:49 PM To: Chicago/food-inspections-evaluation Cc: Schenk, Tom Subject: Re: [food-inspections-evaluation] Location of technical article? (#47)

I started moving the files, it actually created a few small issues. Namely the path gets messed up because Knitr uses the file's location as . rather than the project root folder.

Also, I noticed that the knitcitations library was in loaded in a call to library rather than the load_install_libraries command from geneorama. I don't know if you want to keep this dependency, but I did need to install the library to compile the knitr doc (and the installation is handled by load_install_libraries).

— Reply to this email directly or view it on GitHubhttps://github.com/Chicago/food-inspections-evaluation/issues/47#issuecomment-73801326.

This e-mail, and any attachments thereto, is intended only for use by the addressee(s) named herein and may contain legally privileged and/or confidential information. If you are not the intended recipient of this e-mail (or the person responsible for delivering this document to the intended recipient), you are hereby notified that any dissemination, distribution, printing or copying of this e-mail, and any attachment thereto, is strictly prohibited. If you have received this e-mail in error, please respond to the individual sending the message, and permanently delete the original and any copy of any e-mail and printout thereof.

geneorama commented 9 years ago

I put assets/ into REPORTS, but that messed up the submodule, which seems to have messed up my local repo. Now I'm getting this error with most git commands (including git status): image

However, I'm rethinking the wisdom of putting assets/ into REPORTS, that might also foul up the github pages, right? I think I'll reset and try again.

tomschenkjr commented 9 years ago

gh-pages should be fine, it messes with the Rmd, which can be changed.

Not sure what is happening with the repo. Can you show me your .gitsubmodule file?

Tom Schenk Jr. Chief Data Officer Department of Innovation and Technology City of Chicago (312) 744-2770 tom.schenk@cityofchicago.org data.cityofchicago.org

From: Gene Leynes notifications@github.com Sent: Wednesday, February 11, 2015 8:39:01 AM To: Chicago/food-inspections-evaluation Cc: Schenk, Tom Subject: Re: [food-inspections-evaluation] Location of technical article? (#47)

I put assets/ into REPORTS, but that messed up the submodule, which seems to have messed up my local repo. Now I'm getting this error with most git commands (including git status): [image]https://cloud.githubusercontent.com/assets/1392068/6148677/2f7eea7e-b1c9-11e4-8886-7944c13c1009.png

However, I'm rethinking the wisdom of putting assets/ into REPORTS, that might also foul up the github pages, right? I think I'll reset and try again.

Reply to this email directly or view it on GitHubhttps://github.com/Chicago/food-inspections-evaluation/issues/47#issuecomment-73890856.

This e-mail, and any attachments thereto, is intended only for use by the addressee(s) named herein and may contain legally privileged and/or confidential information. If you are not the intended recipient of this e-mail (or the person responsible for delivering this document to the intended recipient), you are hereby notified that any dissemination, distribution, printing or copying of this e-mail, and any attachment thereto, is strictly prohibited. If you have received this e-mail in error, please respond to the individual sending the message, and permanently delete the original and any copy of any e-mail and printout thereof.

geneorama commented 9 years ago

@tomschenkjr After moving the files and updating the paths, there is one new issue with the citations, which you have offered to take over. This warning now appears in the report.

image

geneorama commented 9 years ago

The report has been moved. I think the warning is a separate issue.