Skip to content

Commit

Permalink
docs(sessions): 📝 add learning objectives for intro
Browse files Browse the repository at this point in the history
Closes #19
  • Loading branch information
lwjohnst86 committed Oct 16, 2024
1 parent 20b3bf0 commit 64101e8
Showing 1 changed file with 24 additions and 16 deletions.
40 changes: 24 additions & 16 deletions sessions/introduction.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,21 @@ The slides contain speaking notes that you can view by pressing 'S' on
the keyboard.
:::

Learning objectives:
## Learning objectives

- Why it can be very powerful and useful to create even a simple R package.
The overall **learning outcome** for this session is:

- Identify when and why to create an R package.
1. Explain in general terms why and how an R package can simplify your
work, as well as a high-level overview of the workflow in developing
an R package.

Specific **objectives** are:

1. Compare the differences in work and effort between creating simple
scripts to help with your and others' work and making a simple R package of
the same code.
2. Describe the benefits and challenges to creating an R package.
3. Outline some basic steps that are necessary to develop an R package.

## The Big Picture

Expand Down Expand Up @@ -98,18 +108,17 @@ package isn't as difficult as it might first sound. But before making a
package, there's a few things to think about. For instance, how do you
determine if you should make an R package? Ask yourself these questions:

- Have you ever made a function, no matter how simple?
- Have you ever used that function more than once across more than one
project or file, either by copying and pasting it or by sourcing the file
that contains it?
- Have you ever made a function, no matter how simple?
- Have you ever used that function more than once across more than one
project or file, either by copying and pasting it or by sourcing the
file that contains it?

If you answered yes to these two questions, then you should
make an R package for that function. But you might wonder, why make a
package with only one function? Because it never stops with *just* one
function, you will very likely be making more in your work. Aside from
packaging up R functions, if you have small to medium sized datasets
that you use across multiple projects or files, you can even package up
the data too.
If you answered yes to these two questions, then you should make an R
package for that function. But you might wonder, why make a package with
only one function? Because it never stops with *just* one function, you
will very likely be making more in your work. Aside from packaging up R
functions, if you have small to medium sized datasets that you use
across multiple projects or files, you can even package up the data too.

Aside from a "yes" to these questions, making an R package now is much
easier than it was in the past. That's largely thanks to R packages like
Expand All @@ -126,5 +135,4 @@ science components of research. That's because making an R package
usually requires a higher level of rigor, testing, documentation, and
inspection of the code, meaning you and others can have more trust in
the results. And if its on GitHub, it's much easier to share your work
with others and have a bigger impact on research overall.

with others and have a bigger impact on research overall.

0 comments on commit 64101e8

Please sign in to comment.