The {avocado} package provides a summary of weekly Hass avocado salesfor the contiguous United States. The underlying data are from The Hass Avocado Board (freeregistration required). Hass Avocados are the most popular variety ofavocados sold in the United States and the Haas Avocado Board (HAB)provides crucial data on them to growers and marketers.
The HAB makes this information available to anyone who may beinterested (free registration required). An important note to rememberis that when they use the term ‘units’, it often means the weight in USpounds. The HAB does not provide (at least publicly) actual piece-countsales to retailers.
About the PLUs
The {avocadoo} package consists of 6 different PLUs:
- 4046: non-organic small/medium Hass Avocados (~3-5 oz)
- 4225: non-organic large Hass Avocados (~8-10 oz)
- 4770: non-organic extra large Hass Avocados (~10-15 oz)
- 94046: organic small/medium Hass Avocados (~3-5 oz)
- 94225: organic large Hass Avocados (~8-10 oz)
- 94770: organic extra large Hass Avocados (~10-15 oz)
Source: Love OneToday
Bags vs PLU
Another distinction that the HAB makes is between bags versus bulk.Bulk typically means avocados sold as individual pieces and are easilydistinguishable with their PLU codes. Hence, the PLU refers to a bulksale. On the other hand, the bags indicates a pre-packaged containerconsisting of a variable number of avocados of mixed PLU type. Forinstance, a package of six avocados may consist of 2 PLU 4046, 3 PLU4770 and 1 PLU 4225. In other words, bagged sales are unable to accountfor individual PLU sales.
See this vignettefor more information.
Installation
Install the development version from GitHub:
# install.packages("devtools")devtools::install_github("nikdata/avocado", ref = 'main')
Datasets
The {avocado} package consists of three different datasets:
hass_usa: weekly contiguous US avocado sales at thecountry levelhass_region: weekly contiguous US avocado sales at theregion levelhass: weekly contiguous US avocado sales at thecity/sub-region level
FAQs
A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. For more information, see "About wikis."
How to write a good README? ›
A good README typically consists of the following sections:
- 3.1: Title and Description. Start with a concise project title and a brief description of what your project does. ...
- 3.2: Table of Contents. ...
- 3.3. ...
- 3.4: Usage. ...
- 5: Contributing. ...
- 6: License. ...
- 3.7: Badges (optional) ...
- Additional Sections.
Format the readme document so it is easy to understand (e.g. separate important pieces of information with blank lines, rather than having all the information in one long paragraph). Format multiple readme files identically. Present the information in the same order, using the same terminology.
What is a README? ›
A README is a text file that introduces and explains a project. It contains information that is commonly required to understand what the project is about.
How do I make my README attractive? ›
Use Clear and Consistent Format
Additionally, by using bullet points, you can make the text more concise and easier to read. A README. txt or README.me file should be written in markdown syntax. Using Markdown, you can format plain text into HTML.
Is a README just a text file? ›
A README is a text file that introduces and explains the contents of your research project folder or published data.
How to write a kickass README? ›
“Good things to have in the README include:
- A brief description of the project.
- A pointer to the project website (if it has one)
- Notes on the developer's build environment and potential portability problems.
- A roadmap describing important files and subdirectories.
General guidelines
- Name the file README . Not readme , read_me , ABOUT , etc. ...
- Write in plain text. Plain text files can be read by any operating system with no fancy software, including in the terminal ( less README. ...
- Include basic information about the project assuming you (the author) are not around to explain it.
The file format is 'md', which stands for Markdown documentation. It is a lightweight markup language that can be easily converted to text.
Can a README be a PDF? ›
There is currently no option to embed a PDF file in an asset README. Alternatively, PDF files can be linked as a resource.
Standard tools to author a README file include proprietary and open source markdown editors, such as Visual Studio Code (VS Code) and GitHub Markdown Editor.
Can you put images in a README? ›
The README.md is not just a plain text file; it's a canvas where you can embed images, GIFs, and videos to make your repo easier to understand and use. Adding visual elements provides context to your code and can be the difference between a passerby and a new contributor or user.
How to write good READMEs? ›
While every ReadMe is different, most should include sections like general information, getting started, included technologies, setup, tests and any bugs or problems. If you mention libraries, provide links to these.
How to write a README text? ›
Write your readme document as a plain text file
To avoid proprietary formats such as MS Word or Rich Text Format (RTF) whenever possible. Format the readme document so it is easy to understand (e.g. separate important pieces of information with blank lines, rather than having all the information in one long paragraph).
What should go into a README? ›
15 Elements to Include in Your README Document
- Project Title. The first thing users should see after opening your README file is the project title. ...
- Project Description. ...
- Table of Contents. ...
- Technologies Used. ...
- Requirements. ...
- Installation Instructions. ...
- Usage Instructions. ...
- Documentation.
This article will hopefully serve as a helpful reference guide while you're creating your own READMEs on GitHub.
- Text Styling: Bold. To make text bold, simply wrap in double asterisks. ...
- Text Styling: Italic. To make text italic, simply wrap in single asterisks. ...
- Headers. ...
- Image Sizing. ...
- Links.
A readme file provides information about a data file and is intended to help ensure that the data can be correctly interpreted by yourself at a later date or by others when sharing or publishing data.
