From 4865f45528d8bb390080398fa7ef89be8fc78e71 Mon Sep 17 00:00:00 2001 From: runner Date: Mon, 18 Mar 2024 19:45:51 +0000 Subject: [PATCH] Rebuild site --- docs/LICENSE.html | 2 +- docs/assessments.html | 6 +- docs/coc.html | 2 +- docs/computer-setup.html | 2 +- docs/faq.html | 2 +- docs/final-project.html | 2 +- docs/index.html | 2 +- docs/individual_assignment1.html | 2 +- docs/individual_assignment2.html | 2 +- docs/individual_assignment3.html | 2 +- docs/individual_assignment4.html | 2 +- docs/individual_assignment5.html | 135 ++++-------------- docs/install_stack_mac.html | 2 +- docs/install_stack_ubuntu.html | 2 +- docs/install_stack_windows.html | 2 +- docs/milestone1.html | 2 +- docs/milestone2.html | 2 +- docs/milestone3.html | 133 ++++++++--------- docs/peer-review.html | 2 +- docs/sample-team-work-contract.html | 2 +- .../header-attrs.js | 0 docs/syllabus.html | 2 +- docs/team-work.html | 2 +- 23 files changed, 112 insertions(+), 200 deletions(-) rename docs/site_libs/{header-attrs-2.25 => header-attrs-2.26}/header-attrs.js (100%) diff --git a/docs/LICENSE.html b/docs/LICENSE.html index a5f6e08..7dad04a 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -2371,7 +2371,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/assessments.html b/docs/assessments.html index ed4e268..821c66c 100644 --- a/docs/assessments.html +++ b/docs/assessments.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + @@ -2597,7 +2597,7 @@

Assessment schedule

10 -Milestone 3 +Milestone 3 functions abstracted to a file/module & tests, function documentation 2023/03/30 23:59 12 @@ -2609,7 +2609,7 @@

Assessment schedule

13 -Individual assignment 5 +Individual assignment 5 Packaging practice 2023/04/06 23:59 13 diff --git a/docs/coc.html b/docs/coc.html index 728494d..4bf9cd5 100644 --- a/docs/coc.html +++ b/docs/coc.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/computer-setup.html b/docs/computer-setup.html index a1b69c5..6159aaa 100644 --- a/docs/computer-setup.html +++ b/docs/computer-setup.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/faq.html b/docs/faq.html index 5660763..61bb614 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/final-project.html b/docs/final-project.html index 88375bc..fac7b49 100644 --- a/docs/final-project.html +++ b/docs/final-project.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/index.html b/docs/index.html index 8ae4a55..18b1a85 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/individual_assignment1.html b/docs/individual_assignment1.html index 19584ea..47e52dd 100644 --- a/docs/individual_assignment1.html +++ b/docs/individual_assignment1.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/individual_assignment2.html b/docs/individual_assignment2.html index 5ad19fd..4ecb178 100644 --- a/docs/individual_assignment2.html +++ b/docs/individual_assignment2.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/individual_assignment3.html b/docs/individual_assignment3.html index 50b9a34..51a9925 100644 --- a/docs/individual_assignment3.html +++ b/docs/individual_assignment3.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/individual_assignment4.html b/docs/individual_assignment4.html index de95083..fc1fc47 100644 --- a/docs/individual_assignment4.html +++ b/docs/individual_assignment4.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/individual_assignment5.html b/docs/individual_assignment5.html index 4e41fbb..753ce88 100644 --- a/docs/individual_assignment5.html +++ b/docs/individual_assignment5.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + @@ -2503,115 +2503,42 @@

Individual assignment 5

Motivation

The purpose of this assignment is to ensure that everyone -gains hands-on practice creating software packages in R.

-

Optional: Python packaging and PyOpenSci feedback

-

This assignment also contains an optional added challenge -to gain hands-on practice creating software packages in Python as well. -There is an open source community component for this optional component. -Please communicate with your instructor about this. -The final due date for this component is flexible, -but you must let the instructor know you are planning to work on this before the main -assignment deadline. -You are not guaranteed to get this point if there is not enough community engagement. -Total potential points is extra 20% (10% for packaging 10% for open source feedback).

-

Note: Just doing the python packaging component will not give you the 10%.

-

Submission instructions

-

In the text box provided for this assignment on Canvas, -you must submit a link to the GitHub.com repository containing the R package -that you create for this assignment.

-

Links to the extra Python components will be submitted here.

+gains hands-on practice creating software packages in R or Python +(or both for bonus points)! +This will help prepare you to work on +and complete your group project for this course.

Exercise instructions

-

Step 1: Create an R Package

-

Read through, -and follow all of the prompts in -The whole game -chapter of the R Packages book. -At the end of this chapter, you will have created a toy R package -that lives inside a public repository on GitHub.com.

-

Tip: create your starting repository on github first. -It’ll make setting up all the local git + GitHub plumbing easier. -They mention this in The Whole Game section on -use_github()

-

To ensure your package is working, set your working directory to be directly -inside the repository containing your package (in RStudio you can do this with an RStudio project) -and then call devtools::load_all(). -If everything is correct, you should now be able to call str_split_one()!

-

Note: This is not the same as manually sourcing or running your str_split_one -function definition in the file.

-

Step 2: Add a new R function to your package

-

Now we are going to add a second function to this package. -Your grade will depend on the quality and correctness of this function and its tests. -Here are the specifications for the function you must add:

-
    -
  1. File named my_add.R in the correct location
    2. -
  2. Function named my_add in the my_add.R file
    3. -
  3. Your my_add function will take 2 parameters, x and y
    4. -
  4. The function will return the sum of the values x and y
    5. -
+

This assignment you will follow the tutorial to create a toy/practice package +using the language you are using for your course project. +Follow the instructions in the chapters linked to below. +Use the code they provide for the package functions.

+

Make an R package:

-

The function will have the following behaviors:

-
my_add(1, 2)       # output: 3
-my_add(1)          # output: 11
-my_add(NA)         # output: NA
-my_add(10, NA)     # output: NA
-my_add("10", "20") # output: error message saying "One of your inputs contains a string value"
-

Your function should have tests that test for edge cases and known errors. -There should be at least 4 different test behavours.

-

Tip: use the check() function from the {devtools} package as you work on your package.

-

Useful additional resources:

+

And/or make a Python package:

-

Optional: Python packaing

-

This is a non-trivial amount of work. -If you want to attempt this please talk to the instructor, -so they can plan the coordination between the PyOpenSci community. -You will have additional time to work on this part of the assignment -if you make a plan with your instructor. -Last minute or late request to do this part of the assignment will not be accepted.

-

We will use the #pyopensci Slack channel to coordinate communications. -You will need to manually join this channel.

-

In general your task will be to create a python package while comparing and contrasting -two sets of instructions.

- -

Note: the more specific and suggestions you can provide in this part of the assignment, -the easier it will be to make a formal contribution to the pyopensci project. -This will be a documented contribution using the Git + GitHub skills we’ve learned in class.

+

Submission Instructions

+

You will submit a PDF to Gradescope for this individual assignment that includes:

+
    +
  1. the URL of the GitHub.com repository containing your toy/practice package in the Python programming language
    2. +
  2. the URL of the GitHub.com repository containing your toy/practice package in the R programming language
    3. +

Rubric

This assignment will be graded for completion as follows:

@@ -2627,24 +2554,24 @@

Rubric

- - + + - + - + - + - - + + @@ -2652,7 +2579,7 @@

Rubric

120%A working toy R package, working toy Python package with a pyopensci contribution.110%A complete and working toy R package, as well as a complete and working toy Python package
100%A working toy R package was created as described in the The whole game with a fully working and adequate set of unit tests.A complete and working toy R or Python package
75%A working toy R package was created as described in the The whole game with the additional function in the package.A complete but non-working toy R or Python package
50%A working toy R package was created as described in the The whole game.A complete but non-working toy R or Python package
25%Non working toy R package was created as described in the The whole game.50%An incomplete but non-working toy R or Python package
0%
-
+
diff --git a/docs/install_stack_mac.html b/docs/install_stack_mac.html index 586fc1e..23f60c8 100644 --- a/docs/install_stack_mac.html +++ b/docs/install_stack_mac.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/install_stack_ubuntu.html b/docs/install_stack_ubuntu.html index 2ebe734..f289f4c 100644 --- a/docs/install_stack_ubuntu.html +++ b/docs/install_stack_ubuntu.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/install_stack_windows.html b/docs/install_stack_windows.html index 6d2111d..3654158 100644 --- a/docs/install_stack_windows.html +++ b/docs/install_stack_windows.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/milestone1.html b/docs/milestone1.html index 1ed892f..416d022 100644 --- a/docs/milestone1.html +++ b/docs/milestone1.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/milestone2.html b/docs/milestone2.html index 84e29d9..97fe229 100644 --- a/docs/milestone2.html +++ b/docs/milestone2.html @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + diff --git a/docs/milestone3.html b/docs/milestone3.html index 81dda0e..86278ec 100644 --- a/docs/milestone3.html +++ b/docs/milestone3.html @@ -90,27 +90,27 @@ DSCI 310: Milestone 3 - + - + - + @@ -2441,7 +2441,7 @@

${suggestion.title}

color: var(--hover-color, white); } - + @@ -2461,7 +2461,7 @@

${suggestion.title}

@@ -2506,8 +2506,8 @@

Contents

  • Overall project summary
  • Milestone 3 summary
  • Submission Instructions