Skip to content
This repository has been archived by the owner on Nov 17, 2022. It is now read-only.

Commit

Permalink
Review syntax of documentation
Browse files Browse the repository at this point in the history
- Add period after every sentence (Roxygen recommendation).
- Use empty lines between function attributes @export, @return, etc.
- Use Markdown where not yet used
- Limit to 80 characters
  • Loading branch information
peterdesmet committed Feb 27, 2019
1 parent dd5ad86 commit cb60868
Show file tree
Hide file tree
Showing 31 changed files with 398 additions and 310 deletions.
30 changes: 15 additions & 15 deletions R/data.R
@@ -1,31 +1,31 @@
#' Sex choices
#'
#' Allowed values for the sex column in bird metadata
#'
#' Sex choices.
#'
#' Allowed values for the sex column in bird metadata.
#'
#' @format character vector
"sex_choices"

#' Species choices
#'
#' Allowed values for the species column in bird metadata
#'
#' Species choices.
#'
#' Allowed values for the species column in bird metadata.
#'
#' @format character vector
"species_choices"

#' Tracks validated
#'
#' Tracks validated.
#'
#' An example data table containing validated bird tracking data (only 100
#' records). This is what you can expect after successfully loading and
#' validating tracking data.
#'
#'
#' @format data table
"tracks_validated"

#' Birds validated
#'
#' Birds validated.
#'
#' An example data table containing validated bird metadata (only 2 records).
#' This is what you can expect after successfully loading and validating bird
#' metadata.
#'
#'
#' @format data table
"birds_validated"
"birds_validated"

0 comments on commit cb60868

Please sign in to comment.