diff --git a/LICENSE-text.html b/LICENSE-text.html
index 6de8ed0..4d562f9 100644
--- a/LICENSE-text.html
+++ b/LICENSE-text.html
@@ -32,8 +32,313 @@ <h1>License</h1>
 
     </div>
 
-<pre>YEAR: 2024
-COPYRIGHT HOLDER: washr authors
+<pre>HIPPOCRATIC LICENSE
+
+Version 3.0, October 2021
+
+https://firstdonoharm.dev/version/3/0/core.txt
+
+TERMS AND CONDITIONS
+
+TERMS AND CONDITIONS FOR USE, COPY, MODIFICATION, PREPARATION OF DERIVATIVE
+WORK, REPRODUCTION, AND DISTRIBUTION:
+
+1. DEFINITIONS:
+
+This section defines certain terms used throughout this license agreement.
+
+1.1. “License” means the terms and conditions, as stated herein, for use, copy,
+modification, preparation of derivative work, reproduction, and distribution of
+Software (as defined below).
+
+1.2. “Licensor” means the copyright and/or patent owner or entity authorized by
+the copyright and/or patent owner that is granting the License.
+
+1.3. “Licensee” means the individual or entity exercising permissions granted by
+this License, including the use, copy, modification, preparation of derivative
+work, reproduction, and distribution of Software (as defined below).
+
+1.4. “Software” means any copyrighted work, including but not limited to
+software code, authored by Licensor and made available under this License.
+
+1.5. “Supply Chain” means the sequence of processes involved in the production
+and/or distribution of a commodity, good, or service offered by the Licensee.
+
+1.6. “Supply Chain Impacted Party” or “Supply Chain Impacted Parties” means any
+person(s) directly impacted by any of Licensee’s Supply Chain, including the
+practices of all persons or entities within the Supply Chain prior to a good or
+service reaching the Licensee.
+
+1.7. “Duty of Care” is defined by its use in tort law, delict law, and/or
+similar bodies of law closely related to tort and/or delict law, including
+without limitation, a requirement to act with the watchfulness, attention,
+caution, and prudence that a reasonable person in the same or similar
+circumstances would use towards any Supply Chain Impacted Party.
+
+1.8. “Worker” is defined to include any and all permanent, temporary, and agency
+workers, as well as piece-rate, salaried, hourly paid, legal young (minors),
+part-time, night, and migrant workers.
+
+2. INTELLECTUAL PROPERTY GRANTS:
+
+This section identifies intellectual property rights granted to a Licensee.
+
+2.1. Grant of Copyright License: Subject to the terms and conditions of this
+License, Licensor hereby grants to Licensee a worldwide, non-exclusive,
+no-charge, royalty-free copyright license to use, copy, modify, prepare
+derivative work, reproduce, or distribute the Software, Licensor authored
+modified software, or other work derived from the Software.
+
+2.2. Grant of Patent License: Subject to the terms and conditions of this
+License, Licensor hereby grants Licensee a worldwide, non-exclusive, no-charge,
+royalty-free patent license to make, have made, use, offer to sell, sell,
+import, and otherwise transfer Software.
+
+3. ETHICAL STANDARDS:
+
+This section lists conditions the Licensee must comply with in order to have
+rights under this License.
+
+The rights granted to the Licensee by this License are expressly made subject to
+the Licensee’s ongoing compliance with the following conditions:
+
+ * 3.1. The Licensee SHALL NOT, whether directly or indirectly, through agents
+   or assigns:
+
+   * 3.1.1. Infringe upon any person’s right to life or security of person,
+     engage in extrajudicial killings, or commit murder, without lawful cause
+     (See Article 3, United Nations Universal Declaration of Human Rights;
+     Article 6, International Covenant on Civil and Political Rights)
+
+   * 3.1.2. Hold any person in slavery, servitude, or forced labor (See Article
+     4, United Nations Universal Declaration of Human Rights; Article 8,
+     International Covenant on Civil and Political Rights);
+
+   * 3.1.3. Contribute to the institution of slavery, slave trading, forced
+     labor, or unlawful child labor (See Article 4, United Nations Universal
+     Declaration of Human Rights; Article 8, International Covenant on Civil and
+     Political Rights);
+
+   * 3.1.4. Torture or subject any person to cruel, inhumane, or degrading
+     treatment or punishment (See Article 5, United Nations Universal
+     Declaration of Human Rights; Article 7, International Covenant on Civil and
+     Political Rights);
+
+   * 3.1.5. Discriminate on the basis of sex, gender, sexual orientation, race,
+     ethnicity, nationality, religion, caste, age, medical disability or
+     impairment, and/or any other like circumstances (See Article 7, United
+     Nations Universal Declaration of Human Rights; Article 2, International
+     Covenant on Economic, Social and Cultural Rights; Article 26, International
+     Covenant on Civil and Political Rights);
+
+   * 3.1.6. Prevent any person from exercising his/her/their right to seek an
+     effective remedy by a competent court or national tribunal (including
+     domestic judicial systems, international courts, arbitration bodies, and
+     other adjudicating bodies) for actions violating the fundamental rights
+     granted to him/her/them by applicable constitutions, applicable laws, or by
+     this License (See Article 8, United Nations Universal Declaration of Human
+     Rights; Articles 9 and 14, International Covenant on Civil and Political
+     Rights);
+
+   * 3.1.7. Subject any person to arbitrary arrest, detention, or exile (See
+     Article 9, United Nations Universal Declaration of Human Rights; Article 9,
+     International Covenant on Civil and Political Rights);
+
+   * 3.1.8. Subject any person to arbitrary interference with a person’s
+     privacy, family, home, or correspondence without the express written
+     consent of the person (See Article 12, United Nations Universal Declaration
+     of Human Rights; Article 17, International Covenant on Civil and Political
+     Rights);
+
+   * 3.1.9. Arbitrarily deprive any person of his/her/their property (See
+     Article 17, United Nations Universal Declaration of Human Rights);
+
+   * 3.1.10. Forcibly remove indigenous peoples from their lands or territories
+     or take any action with the aim or effect of dispossessing indigenous
+     peoples from their lands, territories, or resources, including without
+     limitation the intellectual property or traditional knowledge of indigenous
+     peoples, without the free, prior, and informed consent of indigenous
+     peoples concerned (See Articles 8 and 10, United Nations Declaration on the
+     Rights of Indigenous Peoples);
+
+   * 3.1.11. Interfere with Workers' free exercise of the right to organize and
+     associate (See Article 20, United Nations Universal Declaration of Human
+     Rights; C087 - Freedom of Association and Protection of the Right to
+     Organise Convention, 1948 (No. 87), International Labour Organization;
+     Article 8, International Covenant on Economic, Social and Cultural Rights);
+     and
+
+   * 3.1.12. Harm the environment in a manner inconsistent with local, state,
+     national, or international law.
+
+ * 3.2. The Licensee SHALL:
+
+   * 3.2.1. Provide equal pay for equal work where the performance of such work
+     requires equal skill, effort, and responsibility, and which are performed
+     under similar working conditions, except where such payment is made
+     pursuant to:
+
+     * 3.2.1.1. A seniority system;
+
+     * 3.2.1.2. A merit system;
+
+     * 3.2.1.3. A system which measures earnings by quantity or quality of
+       production; or
+
+     * 3.2.1.4. A differential based on any other factor other than sex, gender,
+       sexual orientation, race, ethnicity, nationality, religion, caste, age,
+       medical disability or impairment, and/or any other like circumstances
+       (See 29 U.S.C.A. § 206(d)(1); Article 23, United Nations Universal
+       Declaration of Human Rights; Article 7, International Covenant on
+       Economic, Social and Cultural Rights; Article 26, International Covenant
+       on Civil and Political Rights); and
+
+   * 3.2.2. Allow for reasonable limitation of working hours and periodic
+     holidays with pay (See Article 24, United Nations Universal Declaration of
+     Human Rights; Article 7, International Covenant on Economic, Social and
+     Cultural Rights).
+
+4. SUPPLY CHAIN IMPACTED PARTIES:
+
+This section identifies additional individuals or entities that a Licensee could
+harm as a result of violating the Ethical Standards section, the condition that
+the Licensee must voluntarily accept a Duty of Care for those individuals or
+entities, and the right to a private right of action that those individuals or
+entities possess as a result of violations of the Ethical Standards section.
+
+4.1. In addition to the above Ethical Standards, Licensee voluntarily accepts a
+Duty of Care for Supply Chain Impacted Parties of this License, including
+individuals and communities impacted by violations of the Ethical Standards. The
+Duty of Care is breached when a provision within the Ethical Standards section
+is violated by a Licensee, one of its successors or assigns, or by an individual
+or entity that exists within the Supply Chain prior to a good or service
+reaching the Licensee.
+
+4.2. Breaches of the Duty of Care, as stated within this section, shall create a
+private right of action, allowing any Supply Chain Impacted Party harmed by the
+Licensee to take legal action against the Licensee in accordance with applicable
+negligence laws, whether they be in tort law, delict law, and/or similar bodies
+of law closely related to tort and/or delict law, regardless if Licensee is
+directly responsible for the harms suffered by a Supply Chain Impacted Party.
+Nothing in this section shall be interpreted to include acts committed by
+individuals outside of the scope of his/her/their employment.
+
+5. NOTICE: This section explains when a Licensee must notify others of the
+License.
+
+5.1. Distribution of Notice: Licensee must ensure that everyone who receives a
+copy of or uses any part of Software from Licensee, with or without changes,
+also receives the License and the copyright notice included with Software (and
+if included by the Licensor, patent, trademark, and attribution notice).
+Licensee must ensure that License is prominently displayed so that any
+individual or entity seeking to download, copy, use, or otherwise receive any
+part of Software from Licensee is notified of this License and its terms and
+conditions. Licensee must cause any modified versions of the Software to carry
+prominent notices stating that Licensee changed the Software.
+
+5.2. Modified Software: Licensee is free to create modifications of the Software
+and distribute only the modified portion created by Licensee, however, any
+derivative work stemming from the Software or its code must be distributed
+pursuant to this License, including this Notice provision.
+
+5.3. Recipients as Licensees: Any individual or entity that uses, copies,
+modifies, reproduces, distributes, or prepares derivative work based upon the
+Software, all or part of the Software’s code, or a derivative work developed by
+using the Software, including a portion of its code, is a Licensee as defined
+above and is subject to the terms and conditions of this License.
+
+6. REPRESENTATIONS AND WARRANTIES:
+
+6.1. Disclaimer of Warranty: TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE
+COMES “AS IS,” WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR SHALL NOT
+BE LIABLE TO ANY PERSON OR ENTITY FOR ANY DAMAGES OR OTHER LIABILITY ARISING
+FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THIS LICENSE, UNDER ANY
+LEGAL CLAIM.
+
+6.2. Limitation of Liability: LICENSEE SHALL HOLD LICENSOR HARMLESS AGAINST ANY
+AND ALL CLAIMS, DEBTS, DUES, LIABILITIES, LIENS, CAUSES OF ACTION, DEMANDS,
+OBLIGATIONS, DISPUTES, DAMAGES, LOSSES, EXPENSES, ATTORNEYS' FEES, COSTS,
+LIABILITIES, AND ALL OTHER CLAIMS OF EVERY KIND AND NATURE WHATSOEVER, WHETHER
+KNOWN OR UNKNOWN, ANTICIPATED OR UNANTICIPATED, FORESEEN OR UNFORESEEN, ACCRUED
+OR UNACCRUED, DISCLOSED OR UNDISCLOSED, ARISING OUT OF OR RELATING TO LICENSEE’S
+USE OF THE SOFTWARE. NOTHING IN THIS SECTION SHOULD BE INTERPRETED TO REQUIRE
+LICENSEE TO INDEMNIFY LICENSOR, NOR REQUIRE LICENSOR TO INDEMNIFY LICENSEE.
+
+7. TERMINATION
+
+7.1. Violations of Ethical Standards or Breaching Duty of Care: If Licensee
+violates the Ethical Standards section or Licensee, or any other person or
+entity within the Supply Chain prior to a good or service reaching the Licensee,
+breaches its Duty of Care to Supply Chain Impacted Parties, Licensee must remedy
+the violation or harm caused by Licensee within 30 days of being notified of the
+violation or harm. If Licensee fails to remedy the violation or harm within 30
+days, all rights in the Software granted to Licensee by License will be null and
+void as between Licensor and Licensee.
+
+7.2. Failure of Notice: If any person or entity notifies Licensee in writing
+that Licensee has not complied with the Notice section of this License, Licensee
+can keep this License by taking all practical steps to comply within 30 days
+after the notice of noncompliance. If Licensee does not do so, Licensee’s
+License (and all rights licensed hereunder) will end immediately.
+
+7.3. Judicial Findings: In the event Licensee is found by a civil, criminal,
+administrative, or other court of competent jurisdiction, or some other
+adjudicating body with legal authority, to have committed actions which are in
+violation of the Ethical Standards or Supply Chain Impacted Party sections of
+this License, all rights granted to Licensee by this License will terminate
+immediately.
+
+7.4. Patent Litigation: If Licensee institutes patent litigation against any
+entity (including a cross-claim or counterclaim in a suit) alleging that the
+Software, all or part of the Software’s code, or a derivative work developed
+using the Software, including a portion of its code, constitutes direct or
+contributory patent infringement, then any patent license, along with all other
+rights, granted to Licensee under this License will terminate as of the date
+such litigation is filed.
+
+7.5. Additional Remedies: Termination of the License by failing to remedy harms
+in no way prevents Licensor or Supply Chain Impacted Party from seeking
+appropriate remedies at law or in equity.
+
+8. MISCELLANEOUS:
+
+8.1. Conditions: Sections 3, 4.1, 5.1, 5.2, 7.1, 7.2, 7.3, and 7.4 are
+conditions of the rights granted to Licensee in the License.
+
+8.2. Equitable Relief: Licensor and any Supply Chain Impacted Party shall be
+entitled to equitable relief, including injunctive relief or specific
+performance of the terms hereof, in addition to any other remedy to which they
+are entitled at law or in equity.
+
+8.3. Severability: If any term or provision of this License is determined to be
+invalid, illegal, or unenforceable by a court of competent jurisdiction, any
+such determination of invalidity, illegality, or unenforceability shall not
+affect any other term or provision of this License or invalidate or render
+unenforceable such term or provision in any other jurisdiction. If the
+determination of invalidity, illegality, or unenforceability by a court of
+competent jurisdiction pertains to the terms or provisions contained in the
+Ethical Standards section of this License, all rights in the Software granted to
+Licensee shall be deemed null and void as between Licensor and Licensee.
+
+8.4. Section Titles: Section titles are solely written for organizational
+purposes and should not be used to interpret the language within each section.
+
+8.5. Citations: Citations are solely written to provide context for the source
+of the provisions in the Ethical Standards.
+
+8.6. Section Summaries: Some sections have a brief italicized description which
+is provided for the sole purpose of briefly describing the section and should
+not be used to interpret the terms of the License.
+
+8.7. Entire License: This is the entire License between the Licensor and
+Licensee with respect to the claims released herein and that the consideration
+stated herein is the only consideration or compensation to be paid or exchanged
+between them for this License. This License cannot be modified or amended except
+in a writing signed by Licensor and Licensee.
+
+8.8. Successors and Assigns: This License shall be binding upon and inure to the
+benefit of the Licensor’s and Licensee’s respective heirs, successors, and
+assigns.
 </pre>
 
   </main></div>
diff --git a/pkgdown.yml b/pkgdown.yml
index bb0c834..329ef60 100644
--- a/pkgdown.yml
+++ b/pkgdown.yml
@@ -3,7 +3,7 @@ pkgdown: 2.1.1
 pkgdown_sha: ~
 articles:
   washr: washr.html
-last_built: 2024-10-23T11:26Z
+last_built: 2024-10-23T13:49Z
 urls:
   reference: https://openwashdata-dev.github.io/washr/reference
   article: https://openwashdata-dev.github.io/washr/articles
diff --git a/reference/setup_dictionary.html b/reference/setup_dictionary.html
index 0fcc4e3..a3b3444 100644
--- a/reference/setup_dictionary.html
+++ b/reference/setup_dictionary.html
@@ -61,10 +61,10 @@ <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2
 
     <div class="section level2">
     <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
-    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> Setting active project to <span style="color: #0000BB;">"/tmp/RtmpLUdjHS"</span>.</span>
+    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> Setting active project to <span style="color: #0000BB;">"/tmp/Rtmpd6X41i"</span>.</span>
 <span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> Creating <span style="color: #0000BB;">R/</span>.</span>
 <span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> Writing <span style="color: #0000BB;">DESCRIPTION</span>.</span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #0000BB;">Package</span>: RtmpLUdjHS</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #0000BB;">Package</span>: Rtmpd6X41i</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #0000BB;">Title</span>: What the Package Does (One Line, Title Case)</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #0000BB;">Version</span>: 0.0.0.9000</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #0000BB;">Authors@R</span> (parsed):</span>
diff --git a/reference/setup_roxygen.html b/reference/setup_roxygen.html
index db85a28..a5794eb 100644
--- a/reference/setup_roxygen.html
+++ b/reference/setup_roxygen.html
@@ -77,8 +77,8 @@ <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2
 
     <div class="section level2">
     <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
-    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> Setting active project to <span style="color: #0000BB;">"/tmp/RtmpLUdjHS"</span>.</span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #0000BB;">Package</span>: RtmpLUdjHS</span>
+    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-msg co"><span class="r-pr">#&gt;</span> <span style="color: #00BB00;">✔</span> Setting active project to <span style="color: #0000BB;">"/tmp/Rtmpd6X41i"</span>.</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #0000BB;">Package</span>: Rtmpd6X41i</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #0000BB;">Title</span>: What the Package Does (One Line, Title Case)</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #0000BB;">Version</span>: 0.0.0.9000</span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #0000BB;">Authors@R</span> (parsed):</span>
diff --git a/search.json b/search.json
index ce609cd..a55fdc5 100644
--- a/search.json
+++ b/search.json
@@ -1 +1 @@
-[{"path":[]},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement . complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.0, available https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. Community Impact Guidelines inspired Mozilla’s code conduct enforcement ladder. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://openwashdata-dev.github.io/washr/articles/washr.html","id":"create-and-process-dataset","dir":"Articles","previous_headings":"","what":"1. Create and process dataset","title":"Get started with washr","text":"initializing R package named fssample devtools, can start set raw data package executing: fssample directory, now new directory data-raw R script data-processing.R inside . Go data-processing.R refer template code import, clean, export dataset. instance, may want change data type column “location” factor reformat column “date” YYYY-MM-DD. executing last lines data-processing.R, namely, directory data/ contains exported data .rds format created root directory.","code":"setup_rawdata() usethis::use_data(fssample, overwrite = TRUE) fs::dir_create(here::here(\"inst\", \"extdata\")) readr::write_csv(fssample,                  here::here(\"inst\", \"extdata\", paste0(\"fssample\", \".csv\"))) openxlsx::write.xlsx(fssample,                      here::here(\"inst\", \"extdata\", paste0(\"fssample\", \".xlsx\")))"},{"path":"https://openwashdata-dev.github.io/washr/articles/washr.html","id":"document-dataset","dir":"Articles","previous_headings":"","what":"2. Document dataset","title":"Get started with washr","text":"next step provide human machine-readable documentation dataset package . documenting package, work DESCRIPTION file running: Next comes dataset documentation. first create dictionary dataset CSV file format. Go data-raw/dictionary.csv, open CSV file, fill empty column description dictionary. dictionary complete, document dataset turning content CSV file roxygen comments executing: Go R/ fill title description dataset.","code":"update_description() setup_dictionary() setup_roxygen()"},{"path":"https://openwashdata-dev.github.io/washr/articles/washr.html","id":"communicate-dataset","dir":"Articles","previous_headings":"","what":"Communicate dataset","title":"Get started with washr","text":"R dataset documentation complete. ’s time communicate public using human-readable visually appealing tools. currently achieve following two components. README pkgdown website Now, ’s time work polishing README website. satisfied , don’t forget re-run build_readme() build_site() update.","code":"setup_readme() # Go to README.Rmd and complete this R Markdown file build_readme() # Generate README.md from README.Rmd setup_website()"},{"path":"https://openwashdata-dev.github.io/washr/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Mian Zhong. Author, maintainer. Margaux Götschmann. Author. Colin Walder. Author. Lars Schöbitz. Author. Global Health Engineering, ETH Zurich. Copyright holder.","code":""},{"path":"https://openwashdata-dev.github.io/washr/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Zhong M, Götschmann M, Walder C, Schöbitz L (2024). washr: Data Package Development Tools Water Sanitation Hygiene Data. R package version 0.0.1, https://openwashdata-dev.github.io/washr/.","code":"@Manual{,   title = {washr: Data Package Development Tools for Water Sanitation and Hygiene Data},   author = {Mian Zhong and Margaux Götschmann and Colin Walder and Lars Schöbitz},   year = {2024},   note = {R package version 0.0.1},   url = {https://openwashdata-dev.github.io/washr/}, }"},{"path":"https://openwashdata-dev.github.io/washr/index.html","id":"washr","dir":"","previous_headings":"","what":"Data Package Development Tools for Water Sanitation and Hygiene Data","title":"Data Package Development Tools for Water Sanitation and Hygiene Data","text":"goal washr provide tools make openwashdata data package workflow consistent efficient.","code":""},{"path":"https://openwashdata-dev.github.io/washr/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Data Package Development Tools for Water Sanitation and Hygiene Data","text":"near future, ’re planning release washr CRAN. now, can install development version GitHub :","code":"# install.packages(\"devtools\") devtools::install_github(\"openwashdata-dev/washr\")"},{"path":"https://openwashdata-dev.github.io/washr/index.html","id":"how-to-use-washr","dir":"","previous_headings":"","what":"How to use washr","title":"Data Package Development Tools for Water Sanitation and Hygiene Data","text":"learn washr, check ‘Get Started’ page. , along ‘Reference’ page, give good overview washr’s current capabilities limitations. decide use washr publishing data (hope !), take look detailed manual. ’s regularly updated walks entire process step--step. manual best bet --date information, ’re constantly improving .","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/fill_dictionary.html","id":null,"dir":"Reference","previous_headings":"","what":"Fill in the dictionary file based on the tidy data information — fill_dictionary","title":"Fill in the dictionary file based on the tidy data information — fill_dictionary","text":"Fill dictionary file based tidy data information","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/fill_dictionary.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fill in the dictionary file based on the tidy data information — fill_dictionary","text":"","code":"fill_dictionary(dict_path, data_dir)"},{"path":"https://openwashdata-dev.github.io/washr/reference/fill_dictionary.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fill in the dictionary file based on the tidy data information — fill_dictionary","text":"dict_path Path dictionary csvfile. data_dir Path directory tidy R data objects. Defaults data/","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/fill_dictionary.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fill in the dictionary file based on the tidy data information — fill_dictionary","text":"tibble data frame dataset dictionary empty description column written.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/fill_dictionary.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fill in the dictionary file based on the tidy data information — fill_dictionary","text":"","code":"if (FALSE) { # \\dontrun{ update_dictionary(dict_path = \"data-raw/my-dictionary.csv\", data = \"data/\") } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/generate_roxygen_docs.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate roxygen2 documentation from a CSV file — generate_roxygen_docs","title":"Generate roxygen2 documentation from a CSV file — generate_roxygen_docs","text":"function takes CSV table columns variable_name description input, optionally filters variable_name, outputs roxygen2 documentation \\describe \\item.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/generate_roxygen_docs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate roxygen2 documentation from a CSV file — generate_roxygen_docs","text":"","code":"generate_roxygen_docs(input_file_path, output_file_path, df_name = NULL)"},{"path":"https://openwashdata-dev.github.io/washr/reference/generate_roxygen_docs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate roxygen2 documentation from a CSV file — generate_roxygen_docs","text":"input_file_path Path input CSV file. output_file_path Path output file contain roxygen2 documentation. df_name Optional name variable filter input dataframe . Default NULL.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/generate_roxygen_docs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate roxygen2 documentation from a CSV file — generate_roxygen_docs","text":"Character string generated roxygen documentation.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/generate_roxygen_docs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate roxygen2 documentation from a CSV file — generate_roxygen_docs","text":"","code":"if (FALSE) { # \\dontrun{ # Generate roxygen2 documentation from example.csv generate_roxygen_docs(\"example.csv\", \"output.R\") # Generate roxygen2 documentation from example.csv for a specific variable name generate_roxygen_docs(\"example.csv\", \"output.R\", df_name = \"specific_variable\") } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_dictionary.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a dictionary file for tidy data sets — setup_dictionary","title":"Create a dictionary file for tidy data sets — setup_dictionary","text":"setup_dictionary() generates dictionary CSV file data/ directory. dictionary file contains information tidy data sets directory, file names, variable names, variable types, descriptions. tidy data exists, dictionary populated relevant information; otherwise, creates empty dictionary CSV file.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_dictionary.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a dictionary file for tidy data sets — setup_dictionary","text":"","code":"setup_dictionary()"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_dictionary.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a dictionary file for tidy data sets — setup_dictionary","text":"NULL. Error raw data found package directory.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_dictionary.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a dictionary file for tidy data sets — setup_dictionary","text":"","code":"#> ✔ Setting active project to \"/tmp/RtmpLUdjHS\". #> ✔ Creating R/. #> ✔ Writing DESCRIPTION. #> Package: RtmpLUdjHS #> Title: What the Package Does (One Line, Title Case) #> Version: 0.0.0.9000 #> Authors@R (parsed): #>     * First Last <first.last@example.com> [aut, cre] (YOUR-ORCID-ID) #> Description: What the package does (one paragraph). #> License: `use_mit_license()`, `use_gpl3_license()` or friends to #>     pick a license #> Encoding: UTF-8 #> Roxygen: list(markdown = TRUE) #> RoxygenNote: 7.3.2 #> ✔ Writing NAMESPACE. #> ✔ Setting active project to \"<no active project>\". if (FALSE) { # \\dontrun{ setup_rawdata() # Go to data_processing.R, clean the raw data and export tidy data setup_dictionary() } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_rawdata.html","id":null,"dir":"Reference","previous_headings":"","what":"Create the data-raw directory with a data-processing.R template — setup_rawdata","title":"Create the data-raw directory with a data-processing.R template — setup_rawdata","text":"setup_rawdata() creates directory raw data example script named data_processing.R importing, processing exporting tidy data. template assumes dataset name data package name.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_rawdata.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create the data-raw directory with a data-processing.R template — setup_rawdata","text":"","code":"setup_rawdata()"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_rawdata.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create the data-raw directory with a data-processing.R template — setup_rawdata","text":"NULL. function create directory \"data-raw\" package directory.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_rawdata.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create the data-raw directory with a data-processing.R template — setup_rawdata","text":"","code":"if (FALSE) { # \\dontrun{   setup_rawdata() } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_readme.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate the README RMarkdown file — setup_readme","title":"Generate the README RMarkdown file — setup_readme","text":"setup_readme() uses openwashdata README template generate README files based datasets retrieved data/ directory. helps creating consistent informative README documentation data packages.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_readme.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate the README RMarkdown file — setup_readme","text":"","code":"setup_readme()"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_readme.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate the README RMarkdown file — setup_readme","text":"NULL. function creates README.Rmd package directory.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_readme.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate the README RMarkdown file — setup_readme","text":"","code":"if (FALSE) { # \\dontrun{ # Generate the README file after setting up the dictionary setup_dictionary() # Complete and save the dictionary CSV file with variable descriptions setup_readme() } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_roxygen.html","id":null,"dir":"Reference","previous_headings":"","what":"Set up roxygen documentation for all tidy data sets using the dictionary — setup_roxygen","title":"Set up roxygen documentation for all tidy data sets using the dictionary — setup_roxygen","text":"Creates updates Roxygen documentation tidy data sets found dictionary file. first run, function creates Roxygen documentation placeholders title description field. dictionary include columns directory, file name, variable name, variable type, description. function generates Roxygen comments information, facilitating consistent thorough documentation data sets. re-run function, function updates variable description entries Roxygen documentation files within R/ directory. title description fields remain unchanged.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_roxygen.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set up roxygen documentation for all tidy data sets using the dictionary — setup_roxygen","text":"","code":"setup_roxygen()"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_roxygen.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set up roxygen documentation for all tidy data sets using the dictionary — setup_roxygen","text":"NULL. function creates documentation files inside \"R/\". Error tidy data found.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_roxygen.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set up roxygen documentation for all tidy data sets using the dictionary — setup_roxygen","text":"","code":"#> ✔ Setting active project to \"/tmp/RtmpLUdjHS\". #> Package: RtmpLUdjHS #> Title: What the Package Does (One Line, Title Case) #> Version: 0.0.0.9000 #> Authors@R (parsed): #>     * First Last <first.last@example.com> [aut, cre] (YOUR-ORCID-ID) #> Description: What the package does (one paragraph). #> License: `use_mit_license()`, `use_gpl3_license()` or friends to #>     pick a license #> Encoding: UTF-8 #> Roxygen: list(markdown = TRUE) #> RoxygenNote: 7.3.2 #> ✔ Setting active project to \"<no active project>\". if (FALSE) { # \\dontrun{ setup_dictionary() # Go to data-raw/dictionary.csv and complete column description. setup_roxygen() } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_website.html","id":null,"dir":"Reference","previous_headings":"","what":"Set up a pkgdown website for the data package — setup_website","title":"Set up a pkgdown website for the data package — setup_website","text":"setup_website() uses openwashdata pkgdown template create website data package based README.md file. website provides structured visually appealing presentation package's documentation.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_website.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set up a pkgdown website for the data package — setup_website","text":"","code":"setup_website(has_example = FALSE)"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_website.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set up a pkgdown website for the data package — setup_website","text":"has_example Logical. pkgdown website include vignette page writing example? Defaults FALSE.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_website.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set up a pkgdown website for the data package — setup_website","text":"NULL. Error README file found.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_website.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set up a pkgdown website for the data package — setup_website","text":"","code":"if (FALSE) { # \\dontrun{ # Set up the pkgdown website including a vignette page  setup_website(has_example = TRUE) } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/update_citation.html","id":null,"dir":"Reference","previous_headings":"","what":"Update the citation file for the dataset. — update_citation","title":"Update the citation file for the dataset. — update_citation","text":"Create citation *.cff file released dataset given DOI(Digital Object Identifier). adds DOI badge README RMarkdown file re-build README.md pkgdown website exists.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/update_citation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update the citation file for the dataset. — update_citation","text":"","code":"update_citation(doi)"},{"path":"https://openwashdata-dev.github.io/washr/reference/update_citation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update the citation file for the dataset. — update_citation","text":"doi DOI(Digital Object Identifier), e.g., 10.5281/zenodo.11185699","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/update_citation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update the citation file for the dataset. — update_citation","text":"NULL. citation .cff file written root directory.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/update_citation.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Update the citation file for the dataset. — update_citation","text":"","code":"if (FALSE) { # \\dontrun{   update_citation(doi = \"10.5281/zenodo.11185699\") } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/update_description.html","id":null,"dir":"Reference","previous_headings":"","what":"Update the DESCRIPTION file to conform with openwashdata standards — update_description","title":"Update the DESCRIPTION file to conform with openwashdata standards — update_description","text":"function updates DESCRIPTION file R package comply openwashdata standards. ensures fields License, Language, Date, URL, others correctly specified.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/update_description.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update the DESCRIPTION file to conform with openwashdata standards — update_description","text":"","code":"update_description(   file = \".\",   github_user = \"https://github.com/openwashdata/\" )"},{"path":"https://openwashdata-dev.github.io/washr/reference/update_description.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update the DESCRIPTION file to conform with openwashdata standards — update_description","text":"file Character. file path DESCRIPTION file R package. Defaults current working directory. github_user Character. URL path GitHub user organization hosts current package. Defaults \"https://github.com/openwashdata\".","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/update_description.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update the DESCRIPTION file to conform with openwashdata standards — update_description","text":"NULL. Update fields directly DESCRIPTION file.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/update_description.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Update the DESCRIPTION file to conform with openwashdata standards — update_description","text":"","code":"if (FALSE) { # \\dontrun{  # Update DESCRIPTION file in the current package update_description()   # Update DESCRIPTION file in a specific package update_description(file = \"path/to/your/package/DESCRIPTION\")   # Update DESCRIPTION file with a specific GitHub user update_description(github_user = \"https://github.com/yourusername\") } # }"}]
+[{"path":[]},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement . complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.0, available https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. Community Impact Guidelines inspired Mozilla’s code conduct enforcement ladder. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://openwashdata-dev.github.io/washr/articles/washr.html","id":"create-and-process-dataset","dir":"Articles","previous_headings":"","what":"1. Create and process dataset","title":"Get started with washr","text":"initializing R package named fssample devtools, can start set raw data package executing: fssample directory, now new directory data-raw R script data-processing.R inside . Go data-processing.R refer template code import, clean, export dataset. instance, may want change data type column “location” factor reformat column “date” YYYY-MM-DD. executing last lines data-processing.R, namely, directory data/ contains exported data .rds format created root directory.","code":"setup_rawdata() usethis::use_data(fssample, overwrite = TRUE) fs::dir_create(here::here(\"inst\", \"extdata\")) readr::write_csv(fssample,                  here::here(\"inst\", \"extdata\", paste0(\"fssample\", \".csv\"))) openxlsx::write.xlsx(fssample,                      here::here(\"inst\", \"extdata\", paste0(\"fssample\", \".xlsx\")))"},{"path":"https://openwashdata-dev.github.io/washr/articles/washr.html","id":"document-dataset","dir":"Articles","previous_headings":"","what":"2. Document dataset","title":"Get started with washr","text":"next step provide human machine-readable documentation dataset package . documenting package, work DESCRIPTION file running: Next comes dataset documentation. first create dictionary dataset CSV file format. Go data-raw/dictionary.csv, open CSV file, fill empty column description dictionary. dictionary complete, document dataset turning content CSV file roxygen comments executing: Go R/ fill title description dataset.","code":"update_description() setup_dictionary() setup_roxygen()"},{"path":"https://openwashdata-dev.github.io/washr/articles/washr.html","id":"communicate-dataset","dir":"Articles","previous_headings":"","what":"Communicate dataset","title":"Get started with washr","text":"R dataset documentation complete. ’s time communicate public using human-readable visually appealing tools. currently achieve following two components. README pkgdown website Now, ’s time work polishing README website. satisfied , don’t forget re-run build_readme() build_site() update.","code":"setup_readme() # Go to README.Rmd and complete this R Markdown file build_readme() # Generate README.md from README.Rmd setup_website()"},{"path":"https://openwashdata-dev.github.io/washr/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Mian Zhong. Author, maintainer. Margaux Götschmann. Author. Colin Walder. Author. Lars Schöbitz. Author. Global Health Engineering, ETH Zurich. Copyright holder.","code":""},{"path":"https://openwashdata-dev.github.io/washr/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Zhong M, Götschmann M, Walder C, Schöbitz L (2024). washr: Data Package Development Tools Water Sanitation Hygiene Data. R package version 0.0.1, https://openwashdata-dev.github.io/washr/.","code":"@Manual{,   title = {washr: Data Package Development Tools for Water Sanitation and Hygiene Data},   author = {Mian Zhong and Margaux Götschmann and Colin Walder and Lars Schöbitz},   year = {2024},   note = {R package version 0.0.1},   url = {https://openwashdata-dev.github.io/washr/}, }"},{"path":"https://openwashdata-dev.github.io/washr/index.html","id":"washr","dir":"","previous_headings":"","what":"Data Package Development Tools for Water Sanitation and Hygiene Data","title":"Data Package Development Tools for Water Sanitation and Hygiene Data","text":"goal washr provide tools make openwashdata data package workflow consistent efficient.","code":""},{"path":"https://openwashdata-dev.github.io/washr/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Data Package Development Tools for Water Sanitation and Hygiene Data","text":"near future, ’re planning release washr CRAN. now, can install development version GitHub :","code":"# install.packages(\"devtools\") devtools::install_github(\"openwashdata-dev/washr\")"},{"path":"https://openwashdata-dev.github.io/washr/index.html","id":"how-to-use-washr","dir":"","previous_headings":"","what":"How to use washr","title":"Data Package Development Tools for Water Sanitation and Hygiene Data","text":"learn washr, check ‘Get Started’ page. , along ‘Reference’ page, give good overview washr’s current capabilities limitations. decide use washr publishing data (hope !), take look detailed manual. ’s regularly updated walks entire process step--step. manual best bet --date information, ’re constantly improving .","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/fill_dictionary.html","id":null,"dir":"Reference","previous_headings":"","what":"Fill in the dictionary file based on the tidy data information — fill_dictionary","title":"Fill in the dictionary file based on the tidy data information — fill_dictionary","text":"Fill dictionary file based tidy data information","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/fill_dictionary.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fill in the dictionary file based on the tidy data information — fill_dictionary","text":"","code":"fill_dictionary(dict_path, data_dir)"},{"path":"https://openwashdata-dev.github.io/washr/reference/fill_dictionary.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fill in the dictionary file based on the tidy data information — fill_dictionary","text":"dict_path Path dictionary csvfile. data_dir Path directory tidy R data objects. Defaults data/","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/fill_dictionary.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fill in the dictionary file based on the tidy data information — fill_dictionary","text":"tibble data frame dataset dictionary empty description column written.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/fill_dictionary.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fill in the dictionary file based on the tidy data information — fill_dictionary","text":"","code":"if (FALSE) { # \\dontrun{ update_dictionary(dict_path = \"data-raw/my-dictionary.csv\", data = \"data/\") } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/generate_roxygen_docs.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate roxygen2 documentation from a CSV file — generate_roxygen_docs","title":"Generate roxygen2 documentation from a CSV file — generate_roxygen_docs","text":"function takes CSV table columns variable_name description input, optionally filters variable_name, outputs roxygen2 documentation \\describe \\item.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/generate_roxygen_docs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate roxygen2 documentation from a CSV file — generate_roxygen_docs","text":"","code":"generate_roxygen_docs(input_file_path, output_file_path, df_name = NULL)"},{"path":"https://openwashdata-dev.github.io/washr/reference/generate_roxygen_docs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate roxygen2 documentation from a CSV file — generate_roxygen_docs","text":"input_file_path Path input CSV file. output_file_path Path output file contain roxygen2 documentation. df_name Optional name variable filter input dataframe . Default NULL.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/generate_roxygen_docs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate roxygen2 documentation from a CSV file — generate_roxygen_docs","text":"Character string generated roxygen documentation.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/generate_roxygen_docs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate roxygen2 documentation from a CSV file — generate_roxygen_docs","text":"","code":"if (FALSE) { # \\dontrun{ # Generate roxygen2 documentation from example.csv generate_roxygen_docs(\"example.csv\", \"output.R\") # Generate roxygen2 documentation from example.csv for a specific variable name generate_roxygen_docs(\"example.csv\", \"output.R\", df_name = \"specific_variable\") } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_dictionary.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a dictionary file for tidy data sets — setup_dictionary","title":"Create a dictionary file for tidy data sets — setup_dictionary","text":"setup_dictionary() generates dictionary CSV file data/ directory. dictionary file contains information tidy data sets directory, file names, variable names, variable types, descriptions. tidy data exists, dictionary populated relevant information; otherwise, creates empty dictionary CSV file.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_dictionary.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a dictionary file for tidy data sets — setup_dictionary","text":"","code":"setup_dictionary()"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_dictionary.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a dictionary file for tidy data sets — setup_dictionary","text":"NULL. Error raw data found package directory.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_dictionary.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a dictionary file for tidy data sets — setup_dictionary","text":"","code":"#> ✔ Setting active project to \"/tmp/Rtmpd6X41i\". #> ✔ Creating R/. #> ✔ Writing DESCRIPTION. #> Package: Rtmpd6X41i #> Title: What the Package Does (One Line, Title Case) #> Version: 0.0.0.9000 #> Authors@R (parsed): #>     * First Last <first.last@example.com> [aut, cre] (YOUR-ORCID-ID) #> Description: What the package does (one paragraph). #> License: `use_mit_license()`, `use_gpl3_license()` or friends to #>     pick a license #> Encoding: UTF-8 #> Roxygen: list(markdown = TRUE) #> RoxygenNote: 7.3.2 #> ✔ Writing NAMESPACE. #> ✔ Setting active project to \"<no active project>\". if (FALSE) { # \\dontrun{ setup_rawdata() # Go to data_processing.R, clean the raw data and export tidy data setup_dictionary() } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_rawdata.html","id":null,"dir":"Reference","previous_headings":"","what":"Create the data-raw directory with a data-processing.R template — setup_rawdata","title":"Create the data-raw directory with a data-processing.R template — setup_rawdata","text":"setup_rawdata() creates directory raw data example script named data_processing.R importing, processing exporting tidy data. template assumes dataset name data package name.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_rawdata.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create the data-raw directory with a data-processing.R template — setup_rawdata","text":"","code":"setup_rawdata()"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_rawdata.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create the data-raw directory with a data-processing.R template — setup_rawdata","text":"NULL. function create directory \"data-raw\" package directory.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_rawdata.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create the data-raw directory with a data-processing.R template — setup_rawdata","text":"","code":"if (FALSE) { # \\dontrun{   setup_rawdata() } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_readme.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate the README RMarkdown file — setup_readme","title":"Generate the README RMarkdown file — setup_readme","text":"setup_readme() uses openwashdata README template generate README files based datasets retrieved data/ directory. helps creating consistent informative README documentation data packages.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_readme.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate the README RMarkdown file — setup_readme","text":"","code":"setup_readme()"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_readme.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate the README RMarkdown file — setup_readme","text":"NULL. function creates README.Rmd package directory.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_readme.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate the README RMarkdown file — setup_readme","text":"","code":"if (FALSE) { # \\dontrun{ # Generate the README file after setting up the dictionary setup_dictionary() # Complete and save the dictionary CSV file with variable descriptions setup_readme() } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_roxygen.html","id":null,"dir":"Reference","previous_headings":"","what":"Set up roxygen documentation for all tidy data sets using the dictionary — setup_roxygen","title":"Set up roxygen documentation for all tidy data sets using the dictionary — setup_roxygen","text":"Creates updates Roxygen documentation tidy data sets found dictionary file. first run, function creates Roxygen documentation placeholders title description field. dictionary include columns directory, file name, variable name, variable type, description. function generates Roxygen comments information, facilitating consistent thorough documentation data sets. re-run function, function updates variable description entries Roxygen documentation files within R/ directory. title description fields remain unchanged.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_roxygen.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set up roxygen documentation for all tidy data sets using the dictionary — setup_roxygen","text":"","code":"setup_roxygen()"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_roxygen.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set up roxygen documentation for all tidy data sets using the dictionary — setup_roxygen","text":"NULL. function creates documentation files inside \"R/\". Error tidy data found.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_roxygen.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set up roxygen documentation for all tidy data sets using the dictionary — setup_roxygen","text":"","code":"#> ✔ Setting active project to \"/tmp/Rtmpd6X41i\". #> Package: Rtmpd6X41i #> Title: What the Package Does (One Line, Title Case) #> Version: 0.0.0.9000 #> Authors@R (parsed): #>     * First Last <first.last@example.com> [aut, cre] (YOUR-ORCID-ID) #> Description: What the package does (one paragraph). #> License: `use_mit_license()`, `use_gpl3_license()` or friends to #>     pick a license #> Encoding: UTF-8 #> Roxygen: list(markdown = TRUE) #> RoxygenNote: 7.3.2 #> ✔ Setting active project to \"<no active project>\". if (FALSE) { # \\dontrun{ setup_dictionary() # Go to data-raw/dictionary.csv and complete column description. setup_roxygen() } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_website.html","id":null,"dir":"Reference","previous_headings":"","what":"Set up a pkgdown website for the data package — setup_website","title":"Set up a pkgdown website for the data package — setup_website","text":"setup_website() uses openwashdata pkgdown template create website data package based README.md file. website provides structured visually appealing presentation package's documentation.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_website.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set up a pkgdown website for the data package — setup_website","text":"","code":"setup_website(has_example = FALSE)"},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_website.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set up a pkgdown website for the data package — setup_website","text":"has_example Logical. pkgdown website include vignette page writing example? Defaults FALSE.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_website.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set up a pkgdown website for the data package — setup_website","text":"NULL. Error README file found.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/setup_website.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set up a pkgdown website for the data package — setup_website","text":"","code":"if (FALSE) { # \\dontrun{ # Set up the pkgdown website including a vignette page  setup_website(has_example = TRUE) } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/update_citation.html","id":null,"dir":"Reference","previous_headings":"","what":"Update the citation file for the dataset. — update_citation","title":"Update the citation file for the dataset. — update_citation","text":"Create citation *.cff file released dataset given DOI(Digital Object Identifier). adds DOI badge README RMarkdown file re-build README.md pkgdown website exists.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/update_citation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update the citation file for the dataset. — update_citation","text":"","code":"update_citation(doi)"},{"path":"https://openwashdata-dev.github.io/washr/reference/update_citation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update the citation file for the dataset. — update_citation","text":"doi DOI(Digital Object Identifier), e.g., 10.5281/zenodo.11185699","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/update_citation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update the citation file for the dataset. — update_citation","text":"NULL. citation .cff file written root directory.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/update_citation.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Update the citation file for the dataset. — update_citation","text":"","code":"if (FALSE) { # \\dontrun{   update_citation(doi = \"10.5281/zenodo.11185699\") } # }"},{"path":"https://openwashdata-dev.github.io/washr/reference/update_description.html","id":null,"dir":"Reference","previous_headings":"","what":"Update the DESCRIPTION file to conform with openwashdata standards — update_description","title":"Update the DESCRIPTION file to conform with openwashdata standards — update_description","text":"function updates DESCRIPTION file R package comply openwashdata standards. ensures fields License, Language, Date, URL, others correctly specified.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/update_description.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update the DESCRIPTION file to conform with openwashdata standards — update_description","text":"","code":"update_description(   file = \".\",   github_user = \"https://github.com/openwashdata/\" )"},{"path":"https://openwashdata-dev.github.io/washr/reference/update_description.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update the DESCRIPTION file to conform with openwashdata standards — update_description","text":"file Character. file path DESCRIPTION file R package. Defaults current working directory. github_user Character. URL path GitHub user organization hosts current package. Defaults \"https://github.com/openwashdata\".","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/update_description.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update the DESCRIPTION file to conform with openwashdata standards — update_description","text":"NULL. Update fields directly DESCRIPTION file.","code":""},{"path":"https://openwashdata-dev.github.io/washr/reference/update_description.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Update the DESCRIPTION file to conform with openwashdata standards — update_description","text":"","code":"if (FALSE) { # \\dontrun{  # Update DESCRIPTION file in the current package update_description()   # Update DESCRIPTION file in a specific package update_description(file = \"path/to/your/package/DESCRIPTION\")   # Update DESCRIPTION file with a specific GitHub user update_description(github_user = \"https://github.com/yourusername\") } # }"}]
diff --git a/sitemap.xml b/sitemap.xml
index 3ad30e2..816fe04 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -1,6 +1,7 @@
 <urlset xmlns = 'http://www.sitemaps.org/schemas/sitemap/0.9'>
 <url><loc>https://openwashdata-dev.github.io/washr/404.html</loc></url>
 <url><loc>https://openwashdata-dev.github.io/washr/CODE_OF_CONDUCT.html</loc></url>
+<url><loc>https://openwashdata-dev.github.io/washr/LICENSE-text.html</loc></url>
 <url><loc>https://openwashdata-dev.github.io/washr/LICENSE.html</loc></url>
 <url><loc>https://openwashdata-dev.github.io/washr/articles/index.html</loc></url>
 <url><loc>https://openwashdata-dev.github.io/washr/articles/washr.html</loc></url>