License
@@ -132,31 +53,27 @@License
Authors
+ +Citation
+ Source:DESCRIPTION
+ -
-
-
-
Tom Cardoso. Author, maintainer. -
-
creator and maintainer
- -
-
Michael Pereira. Contributor. -
-
- -
-
The Globe and Mail Inc.. Copyright holder. -
-
-
Cardoso T (2024). +upstartr: Utilities Powering the Globe and Mail's Data Journalism Template. +R package version 0.1.2, https://globeandmail.github.io/upstartr/, https://github.com/globeandmail/upstartr. +
+@Manual{,
+ title = {upstartr: Utilities Powering the Globe and Mail's Data Journalism Template},
+ author = {Tom Cardoso},
+ year = {2024},
+ note = {R package version 0.1.2, https://globeandmail.github.io/upstartr/},
+ url = {https://github.com/globeandmail/upstartr},
+}
Authors
--
-
+
@@ -80,88 +76,95 @@
-- - -
-
-
-
Upstartr is a companion package to The Globe and Mail’s data journalism template, startr. It contains a series of functions meant to be consumed by the template project, plus additional helpful functions for day-to-day data journalism.
----Installation
++ +
+Upstartr is a companion package to The Globe and Mail’s data journalism template, startr. It contains a series of functions meant to be consumed by the template project, plus additional helpful functions for day-to-day data journalism.
+Or, if you want to run a development version, you can install it from GitHub by doing:
+-
devtools::install_github('globeandmail/upstartr') -library(upstartr)devtools::install_github('globeandmail/upstartr') +library(upstartr)--Reference
-You can find the full reference manual for
+upstartr’s functions here.+-Reference +
+You can find the full reference manual for
upstartr’s functions here.-@@ -170,5 +173,7 @@-Credits
+ -Developers
+ + diff --git a/docs/news/index.html b/docs/news/index.html index 66cf50e..191f3e4 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -1,78 +1,12 @@ - - - - - - - -Changelog • upstartr - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Changelog • upstartr - + + - - - --- - - -+- - + + diff --git a/docs/pkgdown.css b/docs/pkgdown.css index 1273238..80ea5b8 100644 --- a/docs/pkgdown.css +++ b/docs/pkgdown.css @@ -56,8 +56,10 @@ img.icon { float: right; } -img { +/* Ensure in-page images don't run outside their container */ +.contents img { max-width: 100%; + height: auto; } /* Fix bug in bootstrap (only seen in firefox) */ @@ -78,11 +80,10 @@ dd { /* Section anchors ---------------------------------*/ a.anchor { - margin-left: -30px; - display:inline-block; - width: 30px; - height: 30px; - visibility: hidden; + display: none; + margin-left: 5px; + width: 20px; + height: 20px; background-image: url(./link.svg); background-repeat: no-repeat; @@ -90,17 +91,15 @@ a.anchor { background-position: center center; } -.hasAnchor:hover a.anchor { - visibility: visible; -} - -@media (max-width: 767px) { - .hasAnchor:hover a.anchor { - visibility: hidden; - } +h1:hover .anchor, +h2:hover .anchor, +h3:hover .anchor, +h4:hover .anchor, +h5:hover .anchor, +h6:hover .anchor { + display: inline-block; } - /* Fixes for fixed navbar --------------------------*/ .contents h1, .contents h2, .contents h3, .contents h4 { @@ -264,31 +263,26 @@ table { /* Syntax highlighting ---------------------------------------------------- */ -pre { - word-wrap: normal; - word-break: normal; - border: 1px solid #eee; -} - -pre, code { +pre, code, pre code { background-color: #f8f8f8; color: #333; } +pre, pre code { + white-space: pre-wrap; + word-break: break-all; + overflow-wrap: break-word; +} -pre code { - overflow: auto; - word-wrap: normal; - white-space: pre; +pre { + border: 1px solid #eee; } -pre .img { +pre .img, pre .r-plt { margin: 5px 0; } -pre .img img { +pre .img img, pre .r-plt img { background-color: #fff; - display: block; - height: auto; } code a, pre a { @@ -305,9 +299,8 @@ a.sourceLine:hover { .kw {color: #264D66;} /* keyword */ .co {color: #888888;} /* comment */ -.message { color: black; font-weight: bolder;} -.error { color: orange; font-weight: bolder;} -.warning { color: #6A0366; font-weight: bolder;} +.error {font-weight: bolder;} +.warning {font-weight: bolder;} /* Clipboard --------------------------*/ @@ -365,3 +358,27 @@ mark { content: ""; } } + +/* Section anchors --------------------------------- + Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71 +*/ + +div.csl-bib-body { } +div.csl-entry { + clear: both; +} +.hanging-indent div.csl-entry { + margin-left:2em; + text-indent:-2em; +} +div.csl-left-margin { + min-width:2em; + float:left; +} +div.csl-right-inline { + margin-left:2em; + padding-left:1em; +} +div.csl-indent { + margin-left: 2em; +} diff --git a/docs/pkgdown.js b/docs/pkgdown.js index 7e7048f..6f0eee4 100644 --- a/docs/pkgdown.js +++ b/docs/pkgdown.js @@ -80,7 +80,7 @@ $(document).ready(function() { var copyButton = ""; - $(".examples, div.sourceCode").addClass("hasCopyButton"); + $("div.sourceCode").addClass("hasCopyButton"); // Insert copy buttons: $(copyButton).prependTo(".hasCopyButton"); @@ -91,7 +91,7 @@ // Initialize clipboard: var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { text: function(trigger) { - return trigger.parentNode.textContent; + return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); } }); diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index f05ba6a..cac62d6 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,6 +1,6 @@ -pandoc: 2.11.2 -pkgdown: 1.6.1 +pandoc: 2.11.4 +pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2021-02-23T16:57Z +last_built: 2024-01-03T01:41Z diff --git a/docs/reference/begin_processing.html b/docs/reference/begin_processing.html index 0d282da..47b5b0d 100644 --- a/docs/reference/begin_processing.html +++ b/docs/reference/begin_processing.html @@ -1,82 +1,15 @@ - - - - - - - -----Version 0.1.1 2021-02-23 -
-Small bug fixes:
--
-
- Adds an extra newline to the
initialize_startr()log messages so that it stays on its own line.
- - Fixes an issue with
write_plot()where theformatparameter was inadvertently being passed toggsave(), which would then throw an error.
-
+-Version 0.1.2
+Small bug fix: - Fixes an error where
initialize_startr()breaks ifcancensusis among listed packages due to an errant comma.-+-Version 0.1.0 2021-02-15 -
+++Version 0.1.12021-02-23
+Small bug fixes: - Adds an extra newline to the
+initialize_startr()log messages so that it stays on its own line. - Fixes an issue withwrite_plot()where theformatparameter was inadvertently being passed toggsave(), which would then throw an error.Runs the pre-processing step on a startr project. — begin_processing • upstartr - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Runs the pre-processing step on a startr project. — begin_processing • upstartr - - - - - - - - - - - - - - - + + - - - --- - + +- - - -+-+Runs the pre-processing step on a startr project.
- Source:R/run.R+ Source:R/run.Rbegin_processing.Rd--The pre-processing step, run as part of
upstartr::run_process+The pre-processing step, run as part of
upstartr::run_processduring theprocess.Rstage of a startr project, logs all variables currently in the global environment, which will then be removed during the post-processing step to keep the startr environment unpolluted.begin_processing(should_clean_processing_variables = TRUE)
++-+begin_processing(should_clean_processing_variables = TRUE)Arguments
--
+- -should_clean_processing_variables -Either TRUE, FALSE, or pulled from the environment if set.
++Arguments
++Value
+ -A list of all environment variables present before the function was run
+A list of all environment variables present before the function was run
+ - Adds an extra newline to the
