question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add documentation page on migrating from R

See original GitHub issue

Prior of writing it, it should probably be defined the scope of this documentation page. In my understanding, based on the definition in NEP 44, that would be a Reference Guide.

I see two possible ways of putting it:

  1. A short reference of commands and similarities/differences, similar to NumPy for Matlab users.
  2. A longer reference that not only cites similarities/differences, but helps the user to be productive while following NumPy standards.

The befenits I see in the first option: it would be much shorter, thus possibly quicker to write and publish; also, with the right presentation, it should be easy to read, allowing users to quickly start using NumPy to accomplish their goals.

In favor of the second option, we have the assumption that a longer introduction to NumPy, SciPy, and Python would give them a more productive start. For instance, R users usually have R Markdown right on their side, while NumPy users may decide to choose Jupyter; dataframes are part of R, while NumPy users could do same things in pure NumPy or use Pandas on top of it. With this in mind, the second option would contain an introduction to the SciPy ecossystem rather than be limited to NumPy.

Some ideas of topics:

  • Philosophical differences between the two environments
  • Data types
    • vectors, lists, and dataframes vs NumPy and Pandas equivalents
    • how to get the shape of an object
  • Reading documentation of functions
    • ?, ??, and help
    • official websites
  • Reproducible research
    • R Markdown vs Jupyter
  • Distributions (RStudio vs Anaconda perhaps?)
  • Indexing
    • subsetting
    • views
    • copy
  • Element-wise operations
    • tell how NumPy will give them that, but pure Python might cause weird behavior
  • Applying functions on elements/dimensions/array
  • Descriptive statistics
  • Other statistical functions/packages
  • Reading/writing data to disk
  • Plotting
  • tydiverse vs SciPy
  • Debugging/IDEs
  • Interfacing between the two
  • Deployment

Depending on the scope to be defined, some or few may be taken away from this main reference page. In that case, they might generate tutorials that would be linked for furter reading.

Issue Analytics

  • State:open
  • Created 4 years ago
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

3reactions
WarrenWeckessercommented, Mar 22, 2020

I’m slightly hesitant though, since I have the feeling it belongs more naturally in the Pandas than the NumPy docs.

Good point. Pandas has a pretty extensive collection of docs, including Comparison with R / R libraries.

2reactions
rgommerscommented, Mar 21, 2020

This could be very useful. I’m slightly hesitant though, since I have the feeling it belongs more naturally in the Pandas than the NumPy docs.

In my understanding, based on the definition in NEP 44, that would be a Reference Guide.

Reference Guide really is for the NumPy API docs. This would be a How-To I think (“how do I do X in Python vs. X in R”).

Read more comments on GitHub >

github_iconTop Results From Across the Web

Migrating from R Markdown v1 - RStudio
Continuing to Use v1. If you are using RStudio you can force RStudio to render documents using R Markdown v1 by adding a...
Read more >
R Packages (2e) - 17 Function documentation
Base R provides a standard way of documenting a package where each function is documented in a topic, an .Rd file (“R documentation”)...
Read more >
Chapter 4 Migration | blogdown: Creating Websites with R ...
A guide to creating websites with R Markdown and the R package blogdown. ... Usually, it is easier to start a new website...
Read more >
Migrate to a new documentation platform · Issue #2273 - GitHub
We need to decide which documentation system to use, where to host it, and so on. Let's use this issue to map the...
Read more >
Migrating an existing project to use workflowr
To add your R Markdown files to the research website, you can move them to the subdirectory analysis/ (note you can do this...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found