Movatterモバイル変換

How to add a data set

library(textdata)

This package provides infrastructure to make text datasets availablewithin R, even when they are too large to store within an R package orare licensed in such a way that prevents them from being included inOSS-licensed packages.

Do you want to add a new dataset to the textdata package?

• Create a R file namedprefix_*.R in theR/folder, where* is the name of the dataset. Supportedprefixes include
  • dataset_
  • lexicon_
• Inside that file create 3 functions nameddownload_*(),process_*() anddataset_*().
  • Thedownload_*() function should take 1 argument namedfolder_path. It has 2 tasks, first it should check if thefile is already downloaded. If it is already downloaded it should returninvisible(). If the file isn’t at the path it shoulddownload the file to said path.
  • Theprocess_*() function should take 2 arguments,folder_path andname_path.folder_path denotes the the path to the file returned bydownload_* andname_path is the path to wherethe polished data should live. Main point ofprocess_*() isto turn the downloaded file into a .rds file containing a tidytibble.
  • Thedataset_*() function should wrap theload_dataset().
• Add theprocess_*() function to the named listprocess_functions in the file process_functions.R.
• Add thedownload_*() function to the named listdownload_functions in the file download_functions.R.
• Modify theprint_info list in the info.R file.
• Adddataset_*.R to the@include tags indownload_functions.R.
• Add the dataset to the table inREADME.Rmd.
• Add the dataset to_pkgdown.yml.
• Write a bullet in theNEWS.md file.

What are the guidelines for adding datasets?