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.

Sign up for GitHub

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

Better describe UI factor options in readme #165

Merged
merged 3 commits into from
Dec 6, 2024
Merged

Better describe UI factor options in readme #165

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5cefbf4
better describe factor options in readme
Nate-Wessel Dec 3, 2024
24424f9
add footnote explaining midnight wrapping
Nate-Wessel Dec 6, 2024
113a523
fix small typo
Nate-Wessel Dec 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,17 @@ This app was originally developed as a [class project by U of T students](https:

### Via the front-end user-interface

When you [visit the app](https://trans-bdit.intra.prod-toronto.ca/traveltime-request/), you will be prompted to add/create at least one of each of the following:
* a corridor, drawn on the map
* a time range, given in hours of the day, 00 - 23
* a date range (note that the end of the date range is exclusive)
* a day of week selection
* a selection of whether or not to include statutory holidays

The app will combine these factors together to request travel times for all possible combinations. If one of each type of factor is selected, only a single travel time will be estimated with the given parameters.
When you [visit the app](https://trans-bdit.intra.prod-toronto.ca/traveltime-request/), you will be prompted to create at least one of each of the following factors:

| Factor | Description |
| ----- | ----------- |
| Corridor | Drawn on the map, it is a shortest path between two intersections of your choice. Draw it in both directions if you need both directions of travel. |
| Time Range | Times must start and end on the hour and the app accepts integer values between 0 and 24. The final hour is _exclusive_, meaning that a range of 7am to 9am covers two hours, not three. Values of 0 and 24 both interchangeably represent midnight; a time range of 0 - 24 will return all hours of the day. A time range starting after it ends (e.g. 10pm to 4am) will wrap around midnight. |
| Date Range | Use the calendar widget to select a date range. Note that selected ranges are displayed with an exclusive end date. |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth discussing what happens when you wrap around midnight? If you have a range of [day, day+1), the next day is not included. What happens when you input for your time, say [22, 5)? This may be confusing for the reader.

| Day of Week | Identify the days of week to include in the aggregation. |
Copy link

@AdK0101 AdK0101 Dec 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same kind of thing as the day. If you only want Monday data, but you wrap around to Tuesday in your time range, what happens? May be worth just discussing the implications of the wrap around thing somewhere in the readme.

| Holiday Inclusion | Decide whether to include or exclude Ontario's statutory holidays if applicable. You can also opt to do it both ways. |

The app will combine these factors together to request travel times for all valid combinations. If one of each type of factor is selected, only a single travel time will be estimated with the given parameters.

Once each factor type has been validly entered it will turn from red to green. Once one or more of each type of factor is ready, a button will appear allowing you to submit the query. Once the data is returned from the server (this can take a while when there are many combinations to process) you will be prompted to download the data as either CSV or JSON.

Expand Down
Loading