Skip to content

Commit 3c6f76e

Browse files
committed
update description, remove quotes (CRAN request)
1 parent 024642f commit 3c6f76e

File tree

7 files changed

+35
-44
lines changed

7 files changed

+35
-44
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,3 @@ inst/doc
88
/doc/
99
/Meta/
1010
docs/
11-
inst/RELEASE-2.0.2.md/

DESCRIPTION

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,62 +2,62 @@ Package: weatherOz
22
Title: An API Client for Australian Weather and Climate Data Resources
33
Version: 2.0.2
44
Authors@R: c(
5-
person("Rodrigo", "Pires", , "rodrigo.pires@dpird.wa.gov.au", role = c("aut", "cre"),
5+
person("Rodrigo", "Pires", email = "rodrigo.pires@dpird.wa.gov.au", role = c("aut", "cre"),
66
comment = c(ORCID = "0000-0001-7384-6849")),
7-
person("Anna", "Hepworth", , "anna.hepworth@gmail.com", role = "aut",
7+
person("Anna", "Hepworth", email = "anna.hepworth@gmail.com", role = "aut",
88
comment = c(ORCID = "0000-0003-0204-6347")),
9-
person("Rebecca", "O'Leary", , "bec.oleary@curtin.edu.au", role = "aut"),
10-
person("Jonathan", "Carroll", , "rpkg@jcarroll.com.au", role = "aut",
9+
person("Rebecca", "O'Leary", email = "bec.oleary@curtin.edu.au", role = "aut"),
10+
person("Jonathan", "Carroll", email = "rpkg@jcarroll.com.au", role = "aut",
1111
comment = c(ORCID = "0000-0002-1404-5264")),
12-
person("James", "Goldie", , "me@jamesgoldie.dev", role = "aut",
12+
person("James", "Goldie", email = "me@jamesgoldie.dev", role = "aut",
1313
comment = c(ORCID = "0000-0002-5024-6207")),
14-
person("Dean", "Marchiori", , "deanmarchiori@gmail.com", role = "aut",
14+
person("Dean", "Marchiori", email = "deanmarchiori@gmail.com", role = "aut",
1515
comment = c(ORCID = "0000-0002-3430-7225")),
16-
person("Paul", "Melloy", , "paul@melloy.com.au", role = "aut",
16+
person("Paul", "Melloy", email = "paul@melloy.com.au", role = "aut",
1717
comment = c(ORCID = "0000-0003-4253-7167")),
18-
person("Mark", "Padgham", , "mark.padgham@email.com", role = "aut",
18+
person("Mark", "Padgham", email = "mark.padgham@email.com", role = "aut",
1919
comment = c(ORCID = "0000-0003-2172-5265")),
20-
person("Hugh", "Parsonage", , "hugh.parsonage@gmail.com", role = "aut",
20+
person("Hugh", "Parsonage", email = "hugh.parsonage@gmail.com", role = "aut",
2121
comment = c(ORCID = "0000-0003-4055-0835")),
22-
person("Keith", "Pembleton", , "keith.pembleton@unisq.edu.au", role = "ctb",
23-
comment = c(ORCID = "0000-0002-1896-4516", "Contributed code and ideas for original 'bomrang' package that was used in the creation of 'weatherOz'.")),
24-
person("Maëlle", "Salmon", , "maelle.salmon@yahoo.se", role = "ctb",
25-
comment = c(ORCID = "0000-0002-2815-0399", "Contributed to debugging a nasty little bug with CI where timezones caused tests to fail due to 'vcr' not recognising the\n URL when run outside of Australia/Perth TZ! Suggested the use of `withr::local_timzeone()`, see <https://github.com/ropensci/weatherOz/commit/b052bf91973b8d7e147a39e8938405a64622634b>.")),
26-
person("Max", "Moldovan", , "max.moldovan@adelaide.edu.au", role = "ctb",
22+
person("Keith", "Pembleton", email = "keith.pembleton@unisq.edu.au", role = "ctb",
23+
comment = c(ORCID = "0000-0002-1896-4516", "Contributed code and ideas for original bomrang package that was used in the creation of weatherOz.")),
24+
person("Maëlle", "Salmon", email = "maelle.salmon@yahoo.se", role = "ctb",
25+
comment = c(ORCID = "0000-0002-2815-0399", "Contributed to debugging a nasty little bug with CI where timezones caused tests to fail due to vcr not recognising the URL when run outside of Australia-Perth TZ! Suggested the use of local_timzeone().")),
26+
person("Max", "Moldovan", email = "max.moldovan@adelaide.edu.au", role = "ctb",
2727
comment = c(ORCID = "0000-0001-9680-8474", "Contributed valuable feedback on package usage leading to improvements in the package structure and functionality.")),
28-
person("Jimmy", "Ng", , "jimmy.ng@dpird.wa.gov.au", role = "ctb"),
29-
person("Steve", "Collins", , "steve.collins@dpird.wa.gov.au", role = "ctb",
28+
person("Jimmy", "Ng", email = "jimmy.ng@dpird.wa.gov.au", role = "ctb"),
29+
person("Steve", "Collins", email = "steve.collins@dpird.wa.gov.au", role = "ctb",
3030
comment = "Designed the hex logo for 'weatherOz' hex logo."),
31-
person("Adam H.", "Sparks", , "adamhsparks@gmail.com", role = "aut",
31+
person("Adam H.", "Sparks", email = "adamhsparks@gmail.com", role = "aut",
3232
comment = c(ORCID = "0000-0002-0061-8359")),
33-
person("Laurens", "Geffert", , "laurensgeffert@gmail.com", role = "rev"),
34-
person("Sam", "Rogers", , "sam.rogers@adelaide.edu.au", role = "rev"),
33+
person("Laurens", "Geffert", email = "laurensgeffert@gmail.com", role = "rev"),
34+
person("Sam", "Rogers", email = "sam.rogers@adelaide.edu.au", role = "rev"),
3535
person("Western Australia Agriculture Authority (WAAA)", role = "cph"),
3636
person("Curtin University", role = "cph")
3737
)
3838
Description: Provides automated downloading, parsing and formatting of
3939
weather data for Australia through API endpoints provided by the
40-
Department of Primary Industries and Regional Development ('DPIRD') of
40+
Department of Primary Industries and Regional Development (DPIRD) of
4141
Western Australia and by the Science and Technology Division of the
42-
Queensland Government's Department of Environment and Science ('DES').
43-
As well as the Bureau of Meteorology ('BOM') of the Australian
42+
Queensland Government's Department of Environment and Science (DES).
43+
As well as the Bureau of Meteorology (BOM) of the Australian
4444
government precis and coastal forecasts,
4545
and downloading and importing radar and satellite imagery files.
46-
'DPIRD' weather data are accessed through public 'APIs' provided by
47-
'DPIRD', <https://www.dpird.wa.gov.au/online-tools/apis/>, providing
48-
access to weather station data from the 'DPIRD' weather station
46+
DPIRD weather data are accessed through public APIs provided by
47+
DPIRD, <https://www.dpird.wa.gov.au/online-tools/apis/>, providing
48+
access to weather station data from the DPIRD weather station
4949
network. Australia-wide weather data are based on data from the
50-
Australian Bureau of Meteorology ('BOM') data and accessed through
51-
'SILO' (Scientific Information for Land Owners) Jeffrey et al. (2001)
52-
<doi:10.1016/S1364-8152(01)00008-1>. 'DPIRD' data are made available
50+
Australian Bureau of Meteorology (BOM) data and accessed through
51+
SILO (Scientific Information for Land Owners) Jeffrey et al. (2001)
52+
<doi:10.1016/S1364-8152(01)00008-1>. DPIRD data are made available
5353
under a Creative Commons Attribution 3.0 Licence (CC BY 3.0 AU)
5454
license <https://creativecommons.org/licenses/by/3.0/au/deed.en>.
5555
SILO data are released under a Creative Commons Attribution 4.0
5656
International licence (CC BY 4.0)
57-
<https://creativecommons.org/licenses/by/4.0/>. 'BOM' data are (c)
57+
<https://creativecommons.org/licenses/by/4.0/>. BOM data are (c)
5858
Australian Government Bureau of Meteorology and released under a
5959
Creative Commons (CC) Attribution 3.0 licence or Public Access Licence
60-
('PAL') as appropriate, see
60+
(PAL) as appropriate, see
6161
<http://www.bom.gov.au/other/copyright.shtml> for further details.
6262
License: GPL (>= 3)
6363
URL: https://github.com/ropensci/weatherOz/,

NEWS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@
1010
* URL updates following DPIRD IT system migration:
1111
* API endpoints: Maintained on `api.agric.wa.gov.au`
1212
* Updated DPIRD API documentation URLs: `agric.wa.gov.au/apis/api-terms-and-conditions` to `dpird.wa.gov.au/online-tools/apis/api-terms-and-conditions/` and `agric.wa.gov.au/form/dpird-api-registration` to `dpird.wa.gov.au/forms/dpird-api-registration/`
13-
* Updated organisational URL: `pulseaus.com.au/about/australian-pulse-industry` to `grainsaustralia.com.au`
13+
* Updated displaced URL: `pulseaus.com.au/about/australian-pulse-industry` to `grainsaustralia.com.au`
1414
* Updated all references in vignettes, README files, and function documentation
1515

1616
## Additional fixes and improvements:
17+
* Addressed CRAN request to "remove the single quotes around every term in the description that is not a package/software/API name" and removed examples for unexported functions.
18+
1719
* Addressed CRAN URL check issues by updating all redirected links to their new working locations.
1820

1921
* Updated all man pages with corrected URLs; Fixed all broken links in README and vignettes.

R/get_ag_bulletin.R

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,6 @@
3636
#' information. Users of this information are deemed to have read and
3737
#' accepted the conditions described therein.
3838
#'
39-
#' @examplesIf interactive()
40-
#'
41-
#' get_ag_bulletin(state = "QLD")
42-
#'
4339
#' @references
4440
#' Agricultural observations are retrieved from the Australian Bureau of
4541
#' Meteorology (\acronym{BOM}) Weather Data Services Agriculture Bulletins,\cr

cran-comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ All previously problematic DPIRD URLs have been updated to their new locations:
3333
These URLs are now working and accessible following DPIRD's completion of the IT system migration to the new platform.
3434

3535
## Additional notes
36-
This submission addresses the policy violation, the compatibility issues and fixes URL problems identified in R CMD checks.
36+
This submission addresses the policy violation, the compatibility issues and fixes URL problems identified in R CMD checks. Also addressed CRAN request to "remove the single quotes around every term in the description that is not a package/software/API name" and removed examples for unexported functions.

man/get_ag_bulletin.Rd

Lines changed: 0 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/weatherOz-package.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)