From d841d9524649bc9c185899e214f3b43bbbf67ee5 Mon Sep 17 00:00:00 2001
From: Malcolm Morgan <mem48@users.noreply.github.com>
Date: Wed, 11 Sep 2024 17:17:52 +0100
Subject: [PATCH] fix spelling

---
 R/atoc_import.R          | 2 +-
 R/atoc_nr.R              | 2 +-
 R/extdata.R              | 2 +-
 R/get_cal.R              | 2 +-
 R/get_naptan.R           | 2 +-
 R/gtfs_cleaning.R        | 2 +-
 R/nptdr.R                | 2 +-
 R/transxchange.R         | 6 +++---
 R/write_gtfs.R           | 4 ++--
 R/xml_helper_functions.R | 2 +-
 man/get_bank_holidays.Rd | 2 +-
 man/get_naptan.Rd        | 2 +-
 man/gtfs_fast_stops.Rd   | 2 +-
 man/gtfs_write.Rd        | 4 ++--
 man/importMCA.Rd         | 2 +-
 man/load_data.Rd         | 2 +-
 man/nr2gtfs.Rd           | 2 +-
 man/transxchange2gtfs.Rd | 6 +++---
 18 files changed, 24 insertions(+), 24 deletions(-)

diff --git a/R/atoc_import.R b/R/atoc_import.R
index a8ac491..054712f 100644
--- a/R/atoc_import.R
+++ b/R/atoc_import.R
@@ -273,7 +273,7 @@ strip_whitespace <- function(df) {
 #'
 #' @param file Path to .mca file
 #' @param silent logical, should messages be displayed
-#' @param ncores number of cores to use when paralell processing
+#' @param ncores number of cores to use when parallel processing
 #' @param full_import import all data, default FALSE
 #' @param working_timetable use rail industry scheduling times instead of public times
 #' @export
diff --git a/R/atoc_nr.R b/R/atoc_nr.R
index 93d73b5..7946bbf 100644
--- a/R/atoc_nr.R
+++ b/R/atoc_nr.R
@@ -3,7 +3,7 @@
 #' Convert ATOC CIF files from Network Rail to GTFS
 #'
 #' @param path_in Character, path to Network Rail ATOC file e.g."C:/input/toc-full.CIF.gz"
-#' @param silent Logical, should progress messages be surpressed (default TRUE)
+#' @param silent Logical, should progress messages be suppressed (default TRUE)
 #' @param ncores Numeric, When parallel processing how many cores to use
 #'   (default 1)
 #' @param locations where to get tiploc locations (see details)
diff --git a/R/extdata.R b/R/extdata.R
index 2703066..4cc4713 100644
--- a/R/extdata.R
+++ b/R/extdata.R
@@ -130,7 +130,7 @@ check_data <- function(default_tag = "v0.1.2"){
 #'
 #' The ATOC data has inaccurate locations for many tiplocs, this is an improved dataset
 #'
-#' "naptan_missing" Bus Stop Locations missing from NapTAN
+#' "naptan_missing" Bus Stop Locations missing from NaPTAN
 #'
 #' A database of bus stops that are missing from the NAPTAN but are known to
 #' have been used. For some reason the official NAPTAN file is missing a small
diff --git a/R/get_cal.R b/R/get_cal.R
index a009b84..45492f9 100644
--- a/R/get_cal.R
+++ b/R/get_cal.R
@@ -7,7 +7,7 @@
 #' @return data frame
 #' @details TransXchange records bank holidays by name (e.g. Christmas Day),
 #'   some UK bank holidays move around, so this function downloads the official
-#'   bank holiday calendar. The offical feed only covers a short period of time
+#'   bank holiday calendar. The official feed only covers a short period of time
 #'   so this may not be suitable for converting files from the past / future.
 #' @export
 #'
diff --git a/R/get_naptan.R b/R/get_naptan.R
index 4a34ba8..35deccf 100644
--- a/R/get_naptan.R
+++ b/R/get_naptan.R
@@ -6,7 +6,7 @@
 #' @param naptan_extra data frame of missing stops default uses `naptan_missing`
 #' @return data frame of stop locations
 #' @details TransXchange does not store the location of bus stops, so this
-#'   functions downloads them from the offical DfT source. NaPTAN has some
+#'   functions downloads them from the official DfT source. NaPTAN has some
 #'   missing bus stops which are added by UK2GTFS. See `naptan_missing`
 #'
 #'
diff --git a/R/gtfs_cleaning.R b/R/gtfs_cleaning.R
index 651a29c..0f7aff6 100644
--- a/R/gtfs_cleaning.R
+++ b/R/gtfs_cleaning.R
@@ -100,7 +100,7 @@ gtfs_fast_trips <- function(gtfs, maxspeed = 83, routes = TRUE) {
 }
 
 #' Find fast stops
-#' @description A varient of gtfs_fast_trips that can detect stops that may be in the wrong location
+#' @description A variant of gtfs_fast_trips that can detect stops that may be in the wrong location
 #' @param gtfs list of gtfs tables
 #' @param maxspeed the maximum allowed speed in metres per second default 83 m/s
 #'   (about 185 mph the max speed of trains on HS1 line)
diff --git a/R/nptdr.R b/R/nptdr.R
index f90d016..846a62c 100644
--- a/R/nptdr.R
+++ b/R/nptdr.R
@@ -66,7 +66,7 @@ nptdr2gtfs <- function(path = "D:/OneDrive - University of Leeds/Data/UK2GTFS/NP
     message(length(fls_cif)," CIF files found")
   }
 
-  # Import the NapTAN
+  # Import the NaPTAN
   stops <- nptdr_naptan_import(fls_naptan)
 
 
diff --git a/R/transxchange.R b/R/transxchange.R
index 9e16bc7..8fb4d29 100644
--- a/R/transxchange.R
+++ b/R/transxchange.R
@@ -8,7 +8,7 @@
 #' @param cal Calendar object from get_bank_holidays()
 #' @param naptan Naptan stop locations from get_naptan()
 #' @param scotland character, should Scottish bank holidays be used? Can be
-#'   "auto" (defualt), "yes", "no". If "auto" and path_in ends with "S.zip"
+#'   "auto" (default), "yes", "no". If "auto" and path_in ends with "S.zip"
 #'   Scottish bank holidays will be used, otherwise England and Wales bank
 #'   holidays are used.
 #' @param try_mode Logical, if TRUE import and conversion are wrapped in try
@@ -18,12 +18,12 @@
 #' @return A GTFS named list
 #' @details
 #'
-#' This is a meta fucntion which aids TransXchange to GTFS conversion. It simple
+#' This is a meta function which aids TransXchange to GTFS conversion. It simple
 #' runs transxchange_import(), transxchange_export(), gtfs_merge(), gtfs_write()
 #'
 #' Progress Bars
 #'
-#' To minimise overall processing when using mulitple cores the fucntion works
+#' To minimise overall processing when using multiple cores the function works
 #' from largest to smallest file.This can mean the progress bar sits a 0% for
 #' quite some time, before starting to move rapidly.
 #'
diff --git a/R/write_gtfs.R b/R/write_gtfs.R
index e021383..36975e6 100644
--- a/R/write_gtfs.R
+++ b/R/write_gtfs.R
@@ -1,6 +1,6 @@
 #' Write GTFS
 #'
-#' Takes a list of data frames represneting the GTFS fromat and saves them as GTFS
+#' Takes a list of data frames representing the GTFS format and saves them as GTFS
 #' Zip file.
 #'
 #' @param gtfs named list of data.frames
@@ -9,7 +9,7 @@
 #' @param stripComma logical, should commas be stripped from text, default = TRUE
 #' @param stripTab logical, should tab be stripped from text, default = TRUE
 #' @param stripNewline logical, should newline tag be stripped from text, default = TRUE
-#' @param quote logical, should strings be quoted, default = FALSE, passed to data.table::fwrite
+#' @param quote logical, should strings be quoted, default = FALSE, passed to `data.table::fwrite`
 #' @export
 #'
 gtfs_write <- function(gtfs,
diff --git a/R/xml_helper_functions.R b/R/xml_helper_functions.R
index c67833c..8865942 100644
--- a/R/xml_helper_functions.R
+++ b/R/xml_helper_functions.R
@@ -1,4 +1,4 @@
-# TransXchange import fucntions
+# TransXchange import functions
 
 #' Import Simple
 #' ????
diff --git a/man/get_bank_holidays.Rd b/man/get_bank_holidays.Rd
index 77d86d7..41f04f6 100644
--- a/man/get_bank_holidays.Rd
+++ b/man/get_bank_holidays.Rd
@@ -24,6 +24,6 @@ data.
 \details{
 TransXchange records bank holidays by name (e.g. Christmas Day),
   some UK bank holidays move around, so this function downloads the official
-  bank holiday calendar. The offical feed only covers a short period of time
+  bank holiday calendar. The official feed only covers a short period of time
   so this may not be suitable for converting files from the past / future.
 }
diff --git a/man/get_naptan.Rd b/man/get_naptan.Rd
index 908b571..c92bfbb 100644
--- a/man/get_naptan.Rd
+++ b/man/get_naptan.Rd
@@ -23,6 +23,6 @@ https://data.gov.uk/dataset/ff93ffc1-6656-47d8-9155-85ea0b8f2251/national-public
 }
 \details{
 TransXchange does not store the location of bus stops, so this
-  functions downloads them from the offical DfT source. NaPTAN has some
+  functions downloads them from the official DfT source. NaPTAN has some
   missing bus stops which are added by UK2GTFS. See `naptan_missing`
 }
diff --git a/man/gtfs_fast_stops.Rd b/man/gtfs_fast_stops.Rd
index b3f1685..19c6679 100644
--- a/man/gtfs_fast_stops.Rd
+++ b/man/gtfs_fast_stops.Rd
@@ -13,7 +13,7 @@ gtfs_fast_stops(gtfs, maxspeed = 83)
 (about 185 mph the max speed of trains on HS1 line)}
 }
 \description{
-A varient of gtfs_fast_trips that can detect stops that may be in the wrong location
+A variant of gtfs_fast_trips that can detect stops that may be in the wrong location
 }
 \details{
 The function looks a straight line distance between each stop and
diff --git a/man/gtfs_write.Rd b/man/gtfs_write.Rd
index b76902e..f17796d 100644
--- a/man/gtfs_write.Rd
+++ b/man/gtfs_write.Rd
@@ -27,9 +27,9 @@ gtfs_write(
 
 \item{stripNewline}{logical, should newline tag be stripped from text, default = TRUE}
 
-\item{quote}{logical, should strings be quoted, default = FALSE, passed to data.table::fwrite}
+\item{quote}{logical, should strings be quoted, default = FALSE, passed to `data.table::fwrite`}
 }
 \description{
-Takes a list of data frames represneting the GTFS fromat and saves them as GTFS
+Takes a list of data frames representing the GTFS format and saves them as GTFS
 Zip file.
 }
diff --git a/man/importMCA.Rd b/man/importMCA.Rd
index 4e80e56..41f6dd9 100644
--- a/man/importMCA.Rd
+++ b/man/importMCA.Rd
@@ -17,7 +17,7 @@ importMCA(
 
 \item{silent}{logical, should messages be displayed}
 
-\item{ncores}{number of cores to use when paralell processing}
+\item{ncores}{number of cores to use when parallel processing}
 
 \item{full_import}{import all data, default FALSE}
 
diff --git a/man/load_data.Rd b/man/load_data.Rd
index 79c2e1a..c6acb14 100644
--- a/man/load_data.Rd
+++ b/man/load_data.Rd
@@ -36,7 +36,7 @@ So this data is provided in the package.
 
 The ATOC data has inaccurate locations for many tiplocs, this is an improved dataset
 
-"naptan_missing" Bus Stop Locations missing from NapTAN
+"naptan_missing" Bus Stop Locations missing from NaPTAN
 
 A database of bus stops that are missing from the NAPTAN but are known to
 have been used. For some reason the official NAPTAN file is missing a small
diff --git a/man/nr2gtfs.Rd b/man/nr2gtfs.Rd
index 5e12722..6e08d56 100644
--- a/man/nr2gtfs.Rd
+++ b/man/nr2gtfs.Rd
@@ -16,7 +16,7 @@ nr2gtfs(
 \arguments{
 \item{path_in}{Character, path to Network Rail ATOC file e.g."C:/input/toc-full.CIF.gz"}
 
-\item{silent}{Logical, should progress messages be surpressed (default TRUE)}
+\item{silent}{Logical, should progress messages be suppressed (default TRUE)}
 
 \item{ncores}{Numeric, When parallel processing how many cores to use
 (default 1)}
diff --git a/man/transxchange2gtfs.Rd b/man/transxchange2gtfs.Rd
index 56d8744..f60af8e 100644
--- a/man/transxchange2gtfs.Rd
+++ b/man/transxchange2gtfs.Rd
@@ -27,7 +27,7 @@ transxchange2gtfs(
 \item{naptan}{Naptan stop locations from get_naptan()}
 
 \item{scotland}{character, should Scottish bank holidays be used? Can be
-"auto" (defualt), "yes", "no". If "auto" and path_in ends with "S.zip"
+"auto" (default), "yes", "no". If "auto" and path_in ends with "S.zip"
 Scottish bank holidays will be used, otherwise England and Wales bank
 holidays are used.}
 
@@ -46,12 +46,12 @@ TransXchange to GTFS
 \details{
 Convert transxchange files to GTFS
 
-This is a meta fucntion which aids TransXchange to GTFS conversion. It simple
+This is a meta function which aids TransXchange to GTFS conversion. It simple
 runs transxchange_import(), transxchange_export(), gtfs_merge(), gtfs_write()
 
 Progress Bars
 
-To minimise overall processing when using mulitple cores the fucntion works
+To minimise overall processing when using multiple cores the function works
 from largest to smallest file.This can mean the progress bar sits a 0% for
 quite some time, before starting to move rapidly.
 }