Giter Club home page Giter Club logo

starter_folder's Introduction

Starter folder

Overview

This repo provides students with a foundation for their own projects associated with Telling Stories with Data. You do not need every aspect for every paper and you should delete aspects that you do not need.

File Structure

The repo is structured as:

  • data/raw_data contains the raw data as obtained from X.
  • data/analysis_data contains the cleaned dataset that was constructed.
  • model contains fitted models.
  • other contains relevant literature, details about LLM chat interactions, and sketches.
  • paper contains the files used to generate the paper, including the Quarto document and reference bibliography file, as well as the PDF of the paper.
  • scripts contains the R scripts used to simulate, download and clean data.

Statement on LLM usage

Aspects of the code were written with the help of the auto-complete tool, Codriver. The abstract and introduction were written with the help of ChatHorse and the entire chat history is available in inputs/llms/usage.txt.

Some checks

  • Change the rproj file name so that it's not starter_folder.Rproj
  • Change the README title so that it's not Starter folder
  • Remove files that you're not using
  • Update comments in R scripts
  • Remove this checklist

starter_folder's People

Contributors

christina-wei avatar rohanalexander avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

starter_folder's Issues

Peer Review #1

General advice + reminders

Remember to remove the files that are not required, such as the literature, and update the files that are absolutely necessary to make this repository reproducible.

Regarding ReadMe

This repo provides students with a foundation for their own projects associated with Telling Stories with Data

The file structure is clear, but remember to update the overview. Maybe add a singular line about what the paper aims to do.

LLM Usage

The LLM usage is well detailed and the captions really explain what the LLM is solving for without too much cognitive load. Consider adding LLM as a text file instead.

Filter data for December 2018

Consider placing these commands elsewhere? I'm not sure the readme is the best place for them.

Regarding the Paper

Which population group experiences the most frequent transitions between shelters in 2018 and 2023? An analysis on Toronto’s Shelter System Flow"

I like the concept of the paper posed as a rhetorical question! It makes the reader stop and ponder for a second. Consider moving the second sentence to the subtitle. Maybe it could be reworded into something along the tunes of "Do certain demographics face more shelter displacement than others? An analysis of Toronto's homeless shelter systems.

As Toronto faces an extreme homelessness crisis, it is important to understand how much homelessness has increased in the city in 2023 compared to 2018

Using Precis may be a helpful exercise here. The word homelessness is repeated twice, consider the following: As Toronto faces a debilitating homelessness crisis, it is worth examining the direness of the situation as it stands today compared to 5 years ago.

where between

Omit where in the introduction, second line

city council

Capitalise.

analyze the data separated into eight groups

I love the description of variables of interest in the introduction, and the description of labels.

2018 and 2023

I'm curious about the motivation being picking two years instead of comparing how trends change over the years. Any specific reasons?Consider expanding on this.

2.2 Moved to housing

The definitions here are useful! insightful to have included them.

3.2 Comparisons in between

Omit the word in

Move the graphs up and reduce the space between the text and graphs. Also alter ggplot attributes so the labels are displayed without overlap. Try axis test to rotate the labels.

Homeless

Consider appending the word persons to the barchart label.

3.2 Comparisons between

Perhaps would be useful somewhere to cross reference other sources to determine plausible reasons for these trends, or maybe mention some hypotheses. Left wondering "And then what? Why?"

rising house prices

This is what I was looking for! Critically developing on this would add great worth to the work.

limitations on the project

Limitations 'to' the project

Discussion

I thoroughly enjoyed reading this section. Good work!

More individuals actively homeless

This one sentence is the central thesis to your paper, and definitely packs a punch. Consider using it sparingly, and rewording instead of repeating it, since it loses a little magic that way.

Peer Review

Since the assignment seems to be still under works, here is some comments that may be useful what's given

Pdf

  • Remove the "subtitle if needed line" it's rendered in your pdf
  • Remember to finish the abstract, it is "First sentence,..." and so on right now
  • I think your fig tags in the writing sections are not rendering, they have a ? in it
  • Add a Link to your repo on the bottom of the first page where it says "LINK"

General/Repo Related

  • Overall code provided is clean and simple
  • Sketches are included as needed
  • Test Data script is not added
  • Simulate Data has good detail and well-commented
  • Make sure to update your README.md file to your specific assignment
  • Citations are incomplete, but remember to cite R (important!)
  • Data tables, graphs are not added yet but remember to use kable and such tools to generate those, refer to course website
  • Data Analysis writing is missing, ensure to include cross references throughout

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.