#roxygen2 - Twitter Hashtag

about 1 year ago

Tired of writing tempdir()/tempfile() code in your #rstats package examples to be compliant with CRAN's file policy? Get CRAN-compliant file examples with a single #roxygen2 tag: examplesTempdir. 📝 Read more: https://t.co/Irfb3HY3uQ

axiomsofxyz's tweet photo. Tired of writing tempdir()/tempfile() code in your #rstats package examples to be compliant with CRAN's file policy?

Get CRAN-compliant file examples with a single #roxygen2 tag: examplesTempdir.

📝 Read more: https://t.co/Irfb3HY3uQ https://t.co/u42pUDRkzt

0

17

7

4

610

🇲🇽 Leonardo Collado-Torres @lcolladotor

over 2 years ago

In today's class I explained the #purrr package & #apply family + quickly showcased #roxygen2 for function docs 📓 #testthat for checking them ✅ #usethis + #biocthis for sharing them 🕸️ https://t.co/go8642ggkC live demo 📦 Image by @allison_horst https://t.co/GLAHRIJSt4

lcolladotor's tweet photo. In today's class I explained the #purrr package & #apply family + quickly showcased

#roxygen2 for function docs 📓
#testthat for checking them ✅
#usethis + #biocthis for sharing them 🕸️

https://t.co/go8642ggkC live demo 📦

Image by @allison_horst

https://t.co/GLAHRIJSt4 https://t.co/lQswAaphsp

1

31

4

7

2K

Irene Mendoza @phenogirl

about 3 years ago

Last three days we have been intensively and collaborately working in developping different R packages, a workshop organized by @frod_san in a wonderful site, Grazalema mountains. It has been hard work, but very fun! We have learnt very much! #roxygen2 #openscience #git

phenogirl's tweet photo. Last three days we have been intensively and collaborately working in developping different R packages, a workshop organized by @frod_san in a wonderful site, Grazalema mountains. It has been hard work, but very fun! We have learnt very much! #roxygen2 #openscience #git https://t.co/m7nIRNIYay

1

25

9

2

2K

Irene Mendoza @phenogirl

about 3 years ago

Doing outdoors programming in #R. Open air for open science and reproducibility. We are learning a lot in this workshop! Thanks, @hadleywickham for #ROxygen2 package and all inspiration for R packages. @openscience

phenogirl's tweet photo. Doing outdoors programming in #R. Open air for open science and reproducibility. We are learning a lot in this workshop!

Thanks, @hadleywickham for #ROxygen2 package and all inspiration for R packages.

@openscience https://t.co/YJczzNBQqO

1

27

4

1

2K

Matt Johnson 🔥 @mrjoh3

almost 4 years ago

Adding links to #roxygen2 docs used to do my head in. But when to use #markdown syntax instead its easy Add Roxygen: list(markdown = TRUE) to your DESCRIPTION file , then swap: \code{\link[pkg:func]{pkg::func()}} with [pkg::func()] #RStats #package https://t.co/GRwZvXt2xJ

0

3

1

0

Je suis parodie 🇸🇪 🇫🇮 🇺🇦 @rmagn0

about 4 years ago

Do you struggle to remember how to combine #roxygen2 NAMESPACE tags? It shouldn't be too hard, but somehow I always have to think twice... So I decided to put together a cheatsheet (still WIP) with use cases. Feedback is greatly appreciated. #RStats

rmagn0's tweet photo. Do you struggle to remember how to combine #roxygen2 NAMESPACE tags? It shouldn't be too hard, but somehow I always have to think twice... So I decided to put together a cheatsheet (still WIP) with use cases. Feedback is greatly appreciated. #RStats https://t.co/NQC76yATUf

0

1

0

Angelo D'Ambrosio @Bakaburg1

over 4 years ago

Hello #RStats, do you know how to link to a whole package in a #roxygen2 format documentation? Here I see only links to functions inside packages, not just the package https://t.co/9RFgFOtXgM @rtips_share @rstudiotips

0

4

1

0

R Data Berlin @rdataberlin

over 4 years ago

Geeky #rstats discovery: for a better handling of items when writing your #Roxygen2/#markdown 📦 documentation, the curly brackets work! Without them, you have to insert a blank line to escape \itemize{} but then what follows is moved to Details...

$rdataberlin's tweet photo. Geeky #rstats discovery: for a better handling of items when writing your #Roxygen2/#markdown 📦 documentation, the curly brackets work! Without them, you have to insert a blank line to escape \itemize{} but then what follows is moved to Details... https://t.co/4qinkY6lAb$

0

4

1

0

Mikhael Dito Manurung @mikhaeldito313

about 5 years ago

How should we write and document functions in #rstats? See my presentation and live coding session for the R packages book club @R4DScommunity. TLDR: #roxygen2 is awesome! https://t.co/Xv4hkRh6qv

0

10

4

7

0

Dave Clark @microbeEcology

almost 6 years ago

I just used #roxygen2 to produce documentation for my own R function for the first time. It is so ridiculously easy that there is really no excuse not to at least give it a go! #rstats @hadleywickham

microbeEcology's tweet photo. I just used #roxygen2 to produce documentation for my own R function for the first time.

It is so ridiculously easy that there is really no excuse not to at least give it a go!
#rstats @hadleywickham https://t.co/hrVYrRsGl4

1

7

2

1

0

Bryan Hanson @ProfBryanHanson

almost 6 years ago

You can use testthat and/or tinytest as your framework. Pls give it a try and file an issue if you have problems. Will go to CRAN in the near future. Thx! 2/2 #rstats #roxygen2 #tinytest #testthat https://t.co/L4G6auu2lo

0

1

0

Bryan Hanson @ProfBryanHanson

almost 6 years ago

Looking for a few nice ppl to help test a new package. roxut is to unit tests as roxygen2 is to documentation: write your unit tests in the function definition files, alongside other roxygen2 tags. 1/2 #rstats #roxygen2 #tinytest #testthat

0

1

0

Mikkel M Andersen @mikldk

about 6 years ago

#rstats #roxytest now on CRAN. #testthat (@hadleywickham) and #tinytest (@markvdloo) tests using #roxygen2 tags, w/ @egerubak https://t.co/zShOHh8UKx

Mikkel M Andersen @mikldk

over 6 years ago

#roxytest has again been updated. This time with #tinytest roclet and more static analysis (check return and examples tags for exported functions). Please try it out and give feedback! Thanks to @egerubak for helping out! #rstats #roxygen2

0

25

9

2

0

7

4

0

@[email protected] @BenjaminWolfe

about 6 years ago

8/12 Whereas in #rstats there's just 1 convention, #roxygen2, in #python there are at least 2 common easy to read styles of docstring: #numpy-style + Google-style. I prefer Google's style, so that's what I used. You can find more examples here: https://t.co/gXyhqW4dsn

1

5

1

0

@[email protected] @BenjaminWolfe

about 6 years ago

7/12 Yesterday I learned #python has rough analogs for all of these. Here's a toy example of a *docstring*, the equivalent of #rstats's #roxygen2 comments. Notice I included the same kind of summary statement, description, arguments, description of what's returned, + examples.

BenjaminWolfe's tweet photo. 7/12

Yesterday I learned #python has rough analogs for all of these. Here's a toy example of a *docstring*, the equivalent of #rstats's #roxygen2 comments.

Notice I included the same kind of summary statement, description, arguments, description of what's returned, + examples. https://t.co/Xgah1jx8pR

1

4

1

0

@[email protected] @BenjaminWolfe

about 6 years ago

6/12 A final 📦 worth mentioning here is #pkgdown. #roxygen2 makes it easy to create documentation, but it's the kind you'd get by typing ?coord_map in your #rstats session. To get the *web* docs, *also* use #pkgdown. It's very easy + used by 5k+ 📦s. https://t.co/dLELneG5VQ

BenjaminWolfe's tweet photo. 6/12

A final 📦 worth mentioning here is #pkgdown.

#roxygen2 makes it easy to create documentation, but it's the kind you'd get by typing ?coord_map in your #rstats session.

To get the *web* docs, *also* use #pkgdown. It's very easy + used by 5k+ 📦s.

https://t.co/dLELneG5VQ https://t.co/yhYC58zumM

1

3

1

0

@[email protected] @BenjaminWolfe

about 6 years ago

2/12 One of my favorite parts of 📦 development is #roxygen2 for documentation. You use comments above your fn, but include special tags like @param for parameters. I first started encountering roxygen2 comments in tutorials like this 1 from @drsimonj. https://t.co/gnDZElJW6g

BenjaminWolfe's tweet photo. 2/12

One of my favorite parts of 📦 development is #roxygen2 for documentation. You use comments above your fn, but include special tags like @param for parameters.

I first started encountering roxygen2 comments in tutorials like this 1 from @drsimonj.

https://t.co/gnDZElJW6g https://t.co/UD5ExoyeAV

1

7

1

0

Mikkel M Andersen @mikldk

over 6 years ago

#roxytest has again been updated. This time with #tinytest roclet and more static analysis (check return and examples tags for exported functions). Please try it out and give feedback! Thanks to @egerubak for helping out! #rstats #roxygen2

Mikkel M Andersen @mikldk

over 6 years ago

I have updated #roxytest (https://t.co/fc1mt4TZa6) that enables writing #testthat tests in the #roxygen2 documentation to the new #roxygen2 roclet API. Please try it out!

mikldk's tweet photo. I have updated #roxytest (https://t.co/fc1mt4TZa6) that enables writing #testthat tests in the #roxygen2 documentation to the new #roxygen2 roclet API. Please try it out! https://t.co/3iOfj6qo1C

0

49

8

5

0

25

9

2

0

@[email protected] @BenjaminWolfe

over 6 years ago

4/4 It goes w/o saying if you're learning #rstats from #python, check out #roxygen2! https://t.co/bS9YDz6osB

0

2

1

0

@[email protected] @BenjaminWolfe

over 6 years ago

3/4 @hadleywickham's written excellent docs on #roxygen2 best practices in his original #rstats packages book. (I haven't even graduated to the 2nd edition!) https://t.co/Pxtn5P9cS8 Likewise for docstrings you can follow #numpy conventions + examples: https://t.co/DHaQgzPQOe

1

2

1

0

Top Tweets for #roxygen2

Last Seen Hashtags on Sotwe

Trends for you

Most Popular Users