Skip to content

Commit ac85ada

Browse files
committed
docs and spelling"
:q "
1 parent caa86c8 commit ac85ada

6 files changed

Lines changed: 10 additions & 12 deletions

File tree

NEWS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# cancensus - 0.5.4
22
- add a convenience function for creating unique names within given selection of regions from `list_census_regions()`
3+
- added a check and context menu to install `sf` package when user requests spatial data but does not have the required package installed as opposed to erroring out.
4+
- improved checking that correct spatial formats are requested
5+
- preparing for 'sp' spatial format usage deprecation in future versions
36

47
# cancensus - 0.5.3
58
- Added a check and context menu to install `sf` package when user requests spatial data but does not have the required package installed as opposed to stopping with an error.

R/cancensus.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ VALID_LEVELS <- c("Regions","C","PR", "CMA", "CD", "CSD", "ADA","CT", "DA", 'EA'
288288

289289
#' Query the CensusMapper API for available datasets.
290290
#'
291-
#' @param use_cache If set to TRUE (the dfault), data will be read from a temporary local cache for the
291+
#' @param use_cache If set to TRUE (the default), data will be read from a temporary local cache for the
292292
#' duration of the R session, if
293293
#' available. If set to FALSE, query the API for the data, and
294294
#' refresh the temporary cache with the result.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ For larger quotas, please get in touch with Jens [directly](mailto:jens@censusma
4747

4848
For performance reasons, and to avoid unnecessarily drawing down API quotas, **cancensus** caches data queries under the hood. By default, **cancensus** caches in R's temporary directory, but this cache is not persistent across sessions. In order to speed up performance, reduce quota usage, and reduce the need for unnecessary network calls, we recommend assigning a persistent local cache using `set_cancensus_cache_path(<local cache path>, install = TRUE)`, this enables more efficient loading and reuse of downloaded data. Users will be prompted with a suggestion to change their default cache location when making API calls if one has not been set yet.
4949

50-
Starting with version 0.5.2 **cancensus** will automatically check if for data that has been recalled by Statistics Canada and is stored in the local cache via the new data recall API implemented in [CensusMapper](https://censusmapper.ca). Statistics Canada occasionally detects and corrects errors in their census data releases, and **cancensus** will download a list of recalled data at the first invocation of `get_census()` in each session and emit a warning if it detected locally cached data that has been recalled. Removal of the cached recalled data has to be done explicitly by the user via the `remove_recalled_chached_data()` function. If data was cached with **cancenus** versions prior to version 0.5.0 there is insufficient metadata to determine all instances of recalled cached data, but the package will check every time cached data is loaded and can identify recalled data at this point at the latest and issues a warning if recalled data is loaded.
50+
Starting with version 0.5.2 **cancensus** will automatically check if for data that has been recalled by Statistics Canada and is stored in the local cache via the new data recall API implemented in [CensusMapper](https://censusmapper.ca). Statistics Canada occasionally detects and corrects errors in their census data releases, and **cancensus** will download a list of recalled data at the first invocation of `get_census()` in each session and emit a warning if it detected locally cached data that has been recalled. Removal of the cached recalled data has to be done explicitly by the user via the `remove_recalled_chached_data()` function. If data was cached with **cancensus** versions prior to version 0.5.0 there is insufficient metadata to determine all instances of recalled cached data, but the package will check every time cached data is loaded and can identify recalled data at this point at the latest and issues a warning if recalled data is loaded.
5151

5252
### Currently available datasets
5353

@@ -164,7 +164,7 @@ The [tongfen package](https://mountainmath.github.io/tongfen/index.html) automat
164164

165165
### Statistics Canada Attribution
166166

167-
Subject to the Statistics Canada Open Licence Agreement, licensed products using Statistics Canada data should employ the following aknowledgement of source:
167+
Subject to the Statistics Canada Open License Agreement, licensed products using Statistics Canada data should employ the following aknowledgement of source:
168168

169169
```
170170
Acknowledgment of Source

cran-comments.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Update - 0.5.4
22
- add a convenience function for creating unique names within given selection of regions from `list_census_regions()`
3+
- added a check and context menu to install `sf` package when user requests spatial data but does not have the required package installed as opposed to erroring out.
4+
- improved checking that correct spatial formats are requested
35

46
# Update - 0.5.3
5-
- Added a check and context menu to install `sf` package when user requests spatial data but does not have the required package installed as opposed to erroring out.
67
- fixes a bug in the local data recall check
78

89
# Update - v0.5.2

man/get_census.Rd

Lines changed: 1 addition & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/list_census_datasets.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)