search

STAT325-S24 / MobyDick

Other
0 stars 1 forks source link

clean up documentation for MobyDick package #11

Closed nicholasjhorton closed 7 months ago

nicholasjhorton commented 7 months ago

@arogers24 the data package is shaping up well.

Can you please update the documentation and run roxygen2::roxygenize() when you have a chance?

Thanks in advance,

Nick


MobyDick {MobyDick} R Documentation
My data
Description
This is more descriptive text about my data. Even more info is provided here ...

Usage
MobyDick
Format
MobyDick
A data frame with 22243 rows and 1 column:

text
lines of text

line_number
line number

section
section of work the line is found

chapter_number
chapter number

...

Source
https://www.who.int/teams/global-tuberculosis-programme/data
arogers24 commented 7 months ago

Do you mean I should replace the description?

nicholasjhorton commented 7 months ago

That's correct: there's placeholder text there (This is more descriptive text about my data. Even more info is provided here ..., My data, https://www.who.int/teams/global-tuberculosis-programme/data) that needs to be updated with your example.

arogers24 commented 7 months ago

Done! https://github.com/STAT325-S24/MobyDick/commit/27082517c5527baa4c9e7f42c4857340a74733b2

nicholasjhorton commented 7 months ago

This looks great, thanks!