DESCRIPTION

Package: packageSkeleton
Version: 0.0-0.7
Date: 2025-3-7
Title: A GitHub Repository Featuring a Starter Template for R Package Development, Paired with a Quarto-Powered Website
Description: A comprehensive template to jumpstart the development of an R package, complete with a structured framework for coding, documentation, and version control. The package simplifies the process of setting up an R package repository on GitHub, offering built-in integration with Quarto for generating a professional, customizable website to showcase package documentation and vignettes. It is designed to help both new and experienced R developers streamline package creation while ensuring best practices in documentation and collaboration. With minimal setup, users can focus on building and sharing valuable tools within the R ecosystem.
Authors@R: c(person(given=c("Damian", "W."), family="Betebenner", email="dbetebenner@nciea.org", role=c("aut", "cre"), 
        comment = c(ORCID = "0000-0003-0476-5599")),
                person(given=c("Adam", "R."), family="Van Iwaarden", email="avaniwaarden@nciea.org", role="aut"))
Maintainer: Damian W. Betebenner <dbetebenner@nciea.org>
Depends: R (>= 4.0)
Suggests: knitr, rmarkdown
Imports: 
    crayon,
    data.table (>= 1.14.0),
    jsonlite (>= 1.9.0),
    pkgsearch,
    RestRserve (>= 1.2.0),
    testthat (>= 3.2.0),
    toOrdinal,
    utils
URL: https://centerforassessment.github.io/packageSkeleton/
BugReports: https://github.com/centerforassessment/packageSkeleton/issues/
LazyData: Yes
LazyDataCompression: xz
LazyLoad: Yes
ByteCompile: TRUE
License: MIT + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
Config/testthat/edition: 3

getAvailableLanguages: List Available Languages

Description

Returns a list of all available languages in the Hello_World dataset

Usage

getAvailableLanguages()

Details

Get Available Languages

Value

A character vector of available languages

Hello_World: Hello World Greetings Dataset

Description

A dataset containing “Hello, World!” greetings in various languages The Hello_World dataset provides a simple example with greetings in different languages, useful for illustrating basic data frame operations in R.

Usage

data(Hello_World)

Hello_World

Keyword

datasets

Format

A data.table with 47 rows and 3 variables:

  • language: The name of the language
  • hello_world_greeting: The “Hello, World!” greeting in the respective language
  • note: Notes about the language

A data frame with 10 rows and 2 variables:

  • Language: A character vector indicating the language of the Hello World greeting.
  • Hello_World_Greeting: A character vector containing the word “Hello” in different languages.

Source

Manually created for demonstration purposes.

Examples

# Display the Hello_World dataset
Hello_World

# Access the greeting column
Hello_World$Hello_World_Greeting

# Access the language column
Hello_World$Language

helloWorld: Multi-language Hello World Function

Description

Returns “Hello, World!” in various languages using the Hello_World dataset

Usage

helloWorld(language = "English", random = FALSE, include_meta = FALSE)

Arguments

  • language: Character string specifying the language (default: “English”)
  • random: Logical indicating whether to return a random language greeting (default: FALSE)
  • include_meta: Logical indicating whether to include metadata (default: FALSE)

Details

Hello World in Multiple Languages

Value

A list containing the greeting and optional metadata

Examples

helloWorld()  # Returns English greeting
helloWorld("spanish")  # Returns Spanish greeting
helloWorld(random = TRUE)  # Returns random language greeting
helloWorld(include_meta = TRUE)  # Returns greeting with metadata

packageSkeleton-package: A GitHub repository featuring a starter template for R package development, paired with a Quarto-powered website.

Description

packageSkeleton: A GitHub Repository Template for R Package Development with Quarto Integration

Keyword

package

Details

The packageSkeleton R package provides a comprehensive template to jumpstart the development of an R package, complete with a structured framework for coding, documentation, and version control. It simplifies the process of setting up an R package repository on GitHub, offering built-in integration with Quarto for generating a professional, customizable website to showcase package documentation and vignettes. This template is designed to help both new and experienced R developers streamline package creation while ensuring best practices in documentation and collaboration. With minimal setup, users can focus on building and sharing valuable tools within the R ecosystem.

Package: packageSkeleton
Type: Package
Version: 0.0-0.7
Date: 2025-3-7
License: MIT
LazyLoad: yes

Author

Maintainer: Damian W. Betebenner dbetebenner@nciea.org (ORCID) Authors:

Seealso

Useful links: