dev/01_start.R

# Building a Prod-Ready, Robust Shiny Application.
#
# Each step is optional.
#
# 1 - On init
#
## 1.1 - Fill the descripion & set options
##
## Add information about the package that will contain your app

golem::fill_desc(
  pkg_name = "human", # The Name of the package containing the App
  pkg_title = "Human-in-the-Loop NLP", # The Title of the package containing the App
  pkg_description = paste(
    "NLP models benefit from human input, whether it be helping to fix",
    "spelling issues or checking labels. This package contains a shiny app to",
    "help perform those actions."
  ), # The Description of the package containing the App
  author_first_name = "Jon", # Your First Name
  author_last_name = "Harmon",  # Your Last Name
  author_email = "jonthegeek@gmail.com",      # Your Email
  repo_url = "https://github.com/jonthegeek/human"
)

## Use this desc to set {golem} options

golem::set_golem_options()

## 1.2 - Set common Files
##
## If you want to use the MIT licence, README, code of conduct, lifecycle badge, and news

usethis::use_mit_license()  # You can set another licence here
usethis::use_readme_rmd( open = FALSE )
usethis::use_code_of_conduct()
usethis::use_lifecycle_badge( "Experimental" )

usethis::use_news_md( open = FALSE )
usethis::use_git()

## 1.3 - Add a data-raw folder
##
## If you have data in your package
usethis::use_data_raw( name = "my_dataset", open = FALSE ) # Change "my_dataset"

## 1.4 - Init Tests
##
## Create a template for tests

golem::use_recommended_tests()

## 1.5 : Use Recommended Package

golem::use_recommended_deps()

## 1.6 Add various tools

# If you want to change the favicon (default is golem's one)
golem::remove_favicon()
golem::use_favicon() # path = "path/to/ico". Can be an online file.

# Add helper functions
golem::use_utils_ui()
golem::use_utils_server()

# You're now set!
# go to dev/02_dev.R
rstudioapi::navigateToFile( "dev/02_dev.R" )
jonthegeek/human documentation built on Dec. 31, 2019, 12:55 a.m.