Specs gtfs2ntfs: reading calendars & common pre-processing #438
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
datanel
reviewed
Oct 28, 2019
src/documentation/common.md
Outdated
| The objects `contributor` and `dataset` are required, containing at least the | ||
| corresponding identifier (and the name for `contributor`), otherwise the conversion | ||
| stops with an error. The object `feed_infos` is optional. | ||
| The files datasets.txt and contributors.txt provide additional information about the data source. |
There was a problem hiding this comment.
same here
In general I think we should write files in bold or something else
woshilapin
previously requested changes
Oct 28, 2019
| @@ -178,6 +179,17 @@ specified, the conversion should stop immediately with an error. | |||
|
|
|||
| (1) When several GTFS Routes with different `route_type`s are grouped together, the commercial_mode_id with the smallest priority should be used (as specified in chapter "Mapping of route_type with modes"). | |||
|
|
|||
| ### Reading calendars.txt and calendar_dates.txt | |||
| Dates of service are trasnformed into explicit active service exceptions as if using a single NTFS file calendar_dates.txt. The resulting files might be different following an optimization operation applied at the end of the conversion, but the result should be functionally identical. | |||
| * In case both files calendar.txt and calendar_dates.txt are present in the input dataset, the days of the week of the specified services within the date range [`start_date` - `end_date`] are transformed into explicit active service dates, taking into account the dates when service exceptions occur. Note that the generated (`service_id`, `date`) pairs must be unique. | |||
There was a problem hiding this comment.
Similar to what @datanel already mentioned above.
Suggested change
| * In case both files calendar.txt and calendar_dates.txt are present in the input dataset, the days of the week of the specified services within the date range [`start_date` - `end_date`] are transformed into explicit active service dates, taking into account the dates when service exceptions occur. Note that the generated (`service_id`, `date`) pairs must be unique. | |
| * In case both files `calendar.txt` and `calendar_dates.txt` are present in the input dataset, the days of the week of the specified services within the date range [`start_date` - `end_date`] are transformed into explicit active service dates, taking into account the dates when service exceptions occur. Note that the generated (`service_id`, `date`) pairs must be unique. |
| ### Reading calendars.txt and calendar_dates.txt | ||
| Dates of service are trasnformed into explicit active service exceptions as if using a single NTFS file calendar_dates.txt. The resulting files might be different following an optimization operation applied at the end of the conversion, but the result should be functionally identical. | ||
| * In case both files calendar.txt and calendar_dates.txt are present in the input dataset, the days of the week of the specified services within the date range [`start_date` - `end_date`] are transformed into explicit active service dates, taking into account the dates when service exceptions occur. Note that the generated (`service_id`, `date`) pairs must be unique. | ||
| * In case the file calendar.txt is empty or not present in the input dataset, the active service dates are loaded as is. |
There was a problem hiding this comment.
Suggested change
| * In case the file calendar.txt is empty or not present in the input dataset, the active service dates are loaded as is. | |
| * In case the file `calendar.txt` is empty or not present in the input dataset, the active service dates are loaded as is. |
prhod
reviewed
Oct 29, 2019
src/documentation/common.md
Outdated
| A configuration file `config.json`, as it is shown below, is provided for each | ||
| converter and contains additional information about the data source as well as about | ||
| the upstream system that generated the data (if available). In particular, it | ||
| provides the necessary information for the required NTFS files datasets.txt and contributors.txt. |
There was a problem hiding this comment.
Suggested change
| provides the necessary information for the required NTFS files datasets.txt and contributors.txt. | |
| provides the necessary information for: | |
| - the required NTFS files datasets.txt and contributors.txt, | |
| - some additional metadata to be inserted in the `feed_infos.txt` file. |
| @@ -178,6 +179,17 @@ specified, the conversion should stop immediately with an error. | |||
|
|
|||
| (1) When several GTFS Routes with different `route_type`s are grouped together, the commercial_mode_id with the smallest priority should be used (as specified in chapter "Mapping of route_type with modes"). | |||
|
|
|||
| ### Reading calendars.txt and calendar_dates.txt | |||
| Dates of service are trasnformed into explicit active service exceptions as if using a single NTFS file calendar_dates.txt. The resulting files might be different following an optimization operation applied at the end of the conversion, but the result should be functionally identical. | |||
There was a problem hiding this comment.
Suggested change
| Dates of service are trasnformed into explicit active service exceptions as if using a single NTFS file calendar_dates.txt. The resulting files might be different following an optimization operation applied at the end of the conversion, but the result should be functionally identical. | |
| GTFS services are transformed into lists of active dates as if using a single NTFS file calendar_dates.txt. The resulting NTFS files might be different following an optimization operation applied at the end of the conversion, but the result should be functionally identical. |
Shouldn't this calendar optimization be described in the common.md file ?
mergify
bot
dismissed
woshilapin’s stale review
Pull request has been modified.
woshilapin
reviewed
Oct 31, 2019
woshilapin
reviewed
Oct 31, 2019
woshilapin
reviewed
Oct 31, 2019
woshilapin
approved these changes
Nov 4, 2019
prhod
approved these changes
Nov 7, 2019
datanel
approved these changes
Nov 7, 2019
datanel
force-pushed
the
doc_read_gtfs_calendars
branch
from
2b23714 to
e85e429
Compare
woshilapin
approved these changes
Nov 7, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I added the specs on reading calendars and I modified the file data_prefix.md to common.md where I put together the common parts for all converters: for now, the specs on data prefix and datasets/contributors.
Eventually, santizer will be part of this file too.